| Latest release |   {% if cookiecutter.include_ReadTheDocs == 'y' %} |
|---|---|
| Status |   |
| Community |   |
{{cookiecutter.description}}
{{cookiecutter.project_name}} is bound by a Code of Conduct.
To build {{cookiecutter.project_name}} from source,
we highly recommend using virtual environments.
If possible, we strongly recommend that you use
Anaconda as your package manager.
Below we provide instructions both for conda and
for pip.
Ensure that you have conda installed.
Create a virtual environment and activate it:
conda create --name {{cookiecutter.repo_name}}
conda activate {{cookiecutter.repo_name}}
Install the development and documentation dependencies:
conda env update --name {{cookiecutter.repo_name}} --file devtools/conda-envs/test_env.yaml
conda env update --name {{cookiecutter.repo_name}} --file docs/requirements.yaml
Build this package from source:
pip install -e .
If you want to update your dependencies (which can be risky!), run:
conda update --all
And when you are finished, you can exit the virtual environment with:
conda deactivate
To build the package from source, run:
pip install .
If you want to create a development environment, install the dependencies required for tests and docs with:
pip install ".[test,doc]"
The {{cookiecutter.project_name}} source code is hosted at https://github.com/{{cookiecutter.github_url}} and is available under the GNU General Public License, version 2 (see the file LICENSE).
Copyright (c) {% now 'utc', '%Y' %}, {{cookiecutter.author_name}}
Project based on the MDAnalysis Cookiecutter version {{cookiecutter._mda_cc_version}}. Please cite MDAnalysis when using {{cookiecutter.project_name}} in published work.