Instructions

Prerequisites

galactic-algebra-closure requires python 3.11, a programming language that comes pre-installed on Linux and Mac OS X, and which is easily installed on Windows;

Installation

First, install galactic in a virtual environment (conda or venv) using the instructions given in the Quick start guide.

Second, you can install galactic-algebra-closure in the same environment using the following Bash command:

(galactic) $ pip install "galactic-algebra-closure[docs]"

Don’t forget to add the --pre flag if you want the latest unstable build.

If you want to verify package integrity using hashes, you can install galactic-algebra-closure in the same environment with one of the following bash commands:

(galactic) $ pip install -r https://www.thegalactic.org/requirements/stable/galactic-algebra-closure.txt

(galactic) $ pip install -r https://www.thegalactic.org/requirements/stable/galactic-algebra-closure_docs.txt

For the pre-release version, use one of the following Bash commands:

(galactic) $ pip install -r https://www.thegalactic.org/requirements/pre/galactic-algebra-closure.txt

(galactic) $ pip install -r https://www.thegalactic.org/requirements/pre/galactic-algebra-closure_docs.txt

Contributing

Build

Building galactic-algebra-closure requires

• hatch, which is a tool for dependency management and packaging in Python;

• graphviz, which is a graph visualization software;

Build galactic-algebra-closure using the bash command

$ hatch run docs:notebooks [--overwrite]
$ hatch build

Testing

Test galactic-algebra-closure using the following Bash commands:

$ hatch test

Runs the test suite.

$ hatch test --cover

Runs tests with coverage.

$ hatch test --doctest-modules src

Runs doctest.

Linting

Lint galactic-algebra-closure using the following Bash commands:

$ hatch check

for running linting.

$ hatch check --fix

Automatically fixes linting issues.

Documentation

Build the documentation using the following Bash commands:

$ hatch run docs:build

Getting Help

Important

If you have any difficulties with galactic-algebra-closure, please feel welcome to file an issue on GitLab so that we can help.