Installation ∞
The easiest way to install marshallEngine is to use pip
(here we show the install inside of a conda environment):
conda create -n marshallEngine python=3.7 pip
conda activate marshallEngine
pip install marshallEngine
Or you can clone the github repo and install from a local version of the code:
git clone git@github.com:thespacedoctor/marshallEngine.git
cd marshallEngine
python setup.py install
To upgrade to the latest version of marshallEngine use the command:
pip install marshallEngine --upgrade
To check installation was successful run marshallEngine -v
. This should return the version number of the install.
Development ∞
If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:
git clone git@github.com:thespacedoctor/marshallEngine.git
cd marshallEngine
python setup.py develop
Pull requests are welcomed!