The QDYN Python Package
See the full documentation for details.
Assuming that you have either a scientific Python distribution installed in your home directory (recommended), or created and activated a virtual environment, you can install the latest official release of the QDYN package with
pip install QDYN
Lastly, to install the latest master from the github repository:
pip install -I git+https://github.com/goerz/qdynpylib.git#egg=QDYN
To uninstall, run
pip uninstall QDYN
Note that a "manual" installation via
python setup.py install from a checkout
of the source code is not recommended, as it provides no possibility for an
automatic uninstall. When installing from a local checkout, you may use
make install or
It is strongly recommended to use the Anaconda Python distribution.
Development of the QDYN package follows the git-flow branching model with the default settings. After cloning the repository, you must run
git checkout master git checkout develop git flow init -d
The first two commands are essential for ensuring that both the
develop branch exist and are tracking their respective branch in
git flow init will fail, or produce incorrectly set up branches.
All pull requests must be against the
From a checkout of the library source code, execute
to run the automated tests.