Installation

From source

The sources for event-detection can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/glotzerlab/dupin

Or download the tarball:

$ curl -OJL https://github.com/glotzerlab/dupin/tarball/main

Once you have a copy of the source, you can install it with:

$ python -m pip install /path/to/clone

Building Documentation

Currently the documentation is not available online, but can be built locally. The required packages are

• furo

• sphinx

• nbsphinx

These can be installed with python3 -m pip install sphinx nbsphinx furo. To build documentation in the project base directory run python3 -m sphinx ./docs ./docs/_build. To view the built documentation open the index.html file in ./docs/_build with your preferred browser.