Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 5.19 KB

README.md

File metadata and controls

104 lines (73 loc) · 5.19 KB

mda-openbabel-converter

Latest release Last release tag GitHub commits since latest release (by date) for a branch Documentation Status
Status GH Actions Status codecov
Community License: GPL v2 Powered by MDAnalysis

A package to convert between MDAnalysis and OpenBabel Objects

mda-openbabel-converter is bound by a Code of Conduct.

Installation

To build mda-openbabel-converter 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.

Documentation

The docs can be found [here] (https://mda-openbabel-converter.readthedocs.io/en/latest/)

With conda

Ensure that you have conda installed.

Create a virtual environment and activate it:

conda create --name mda-openbabel-converter
conda activate mda-openbabel-converter

Install the development and documentation dependencies:

conda env update --name mda-openbabel-converter --file devtools/conda-envs/test_env.yaml
conda env update --name mda-openbabel-converter --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

With pip

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]"

Copyright

The mda-openbabel-converter source code is hosted at https://github.com/lunamorrow/mda-openbabel-converter and is available under the GNU General Public License, version 2 (see the file LICENSE).

Copyright (c) 2024, Luna Morrow

Acknowledgements

Project based on the MDAnalysis Cookiecutter version 0.1. Please cite MDAnalysis when using mda-openbabel-converter in published work.