GitHub

Instructions for installing the project from the source code.

Acquiring a Copy

To acquire a copy of the source code, one can clone the repository, download a release, or use the GitHub CLI.

After a copy has been acquired, install the extra dependencies.

Clone

In order to clone the repository, you must have git installed; if you are on macOS or Linux, you almost certainly already have this installed.

You can clone the repository using either the HTTPS or SSH URL. If you do not know which to choose, or do not intend to commit to the project, use HTTPS.

To clone with the HTTPS URL:

git clone https://github.com/bradendubois/do-calculus.git

To clone with the SSH URL:

git clone git@github.com:bradendubois/do-calculus.git

Release

The project's releases page shows all tagged version of the project, according to semantic versioning. Both .zip and .tar.gz archives are available.

Releases: https://github.com/bradendubois/do-calculus/releases

Releases are automatically created, tagged, and versioned using semantic-release.

CLI

To clone with the GitHub CLI.

gh repo clone bradendubois/do-calculus

Extra Dependencies

After acquiring a copy from any of the above steps:

pip install -r requirements.txt

The above command will install all dependencies listed in requirements.txt.

Further

An API is available and details can be found here.