Installation

Installing with pip

Stable releases of pydmqmc are available via pip:

$ pip install pydmqmc

Building from Source

First, clone the repository:

$ git clone https://github.com/shepherd-group/pydmqmc.git
$ cd pydmqmc
$ git switch release_alpha

Then, build the Python package. Since this project is in early development, it’s advisable to build with the --editable or -e flag:

$ pip install -e .

Building the Documentation

The pydmqmc documentation can be built using Sphinx. To build the documentation locally:

$ cd docs
$ make html

The documentation can then be accessed by opening docs/build/html/index.html with a web browser.