- Overview
- Installation
- Creating python environment
- Installing games
- Setup developing environment
- What is included?
- File structure
- Command line interface
- Documentation
- Update documentation
- Examples
- Developer Guide
- GitHub refresher
Sandworm is a simple hobby project for chill weekends. The objective is to gain a better understanding of playable simulations. Sandworm will contain several different playable simulations.
Install the package by running the follow commands inside the repository. This will perform a developmental version install. It is good practice to do this inside of a virtual environment. A yaml environmental file has been created to automate the installation of dependencies.
Remember to update your GitHub ssh keys.
git clone [email protected]:davidkastner/sandworm.git
cd sandworm
All the dependencies can be loaded together using the prebuilt environment.yml. Compatibility is automatically tested for python versions 3.8 and higher. Installing all packages together via the yaml will produce a more robust and efficient environment.
conda env create -f environment.yml
conda activate sandworm # You may need to use source activate qa
Next, we will perform an development install:
python -m pip install -e .
This is the the package structure for reference and its included modules.
.
|── cli.py # Command-line interface entry point
├── docs # Readthedocs documentation site
├── sandworm # Directory containing the playable simulations
│ ├── game_1
│ ├── game_2
│ ├── game_3
│ └── game_4
└── ...
The contents of the library are designed to be navigated through the commandline interface. Add the following line to your bash.rc
alias sandworm='python /the/path/to/sandworm/cli.py'
Now you can call the sandworm package CLI from anywhere with:
sandworm
Run the following commands to update the ReadTheDocs site:
make clean
make html
git status
git pull
git add -A .
git commit -m "Change a specific functionality"
git push -u origin main
git checkout main
git pull
# Before you begin making changes, create a new branch
git checkout -b new-feature-branch
git add -A
git commit -m "Detailed commit message describing the changes"
git push -u origin new-feature-branch
# Visit github.com to add description, submit, merge the pull request
# Once finished on github.com, return to local
git checkout main
git pull
# Delete the remote branch
git branch -d new-feature-branch
git stash push --include-untracked
git stash drop
git pull
Copyright (c) 2022, David W. Kastner
MolSSI version 1.1.