Instructions

Instructions#

galactic-algebra-kernel requires Python 3.11, which is available on many Linux distributions and on macOS, and is easily installed on Windows.

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-kernel in the same environment using the bash command:

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

If you want the latest unstable build, add the --pre flag.

Building galactic-algebra-kernel requires

hatch, which is a tool for dependency management and packaging in Python;
graphviz, which is graph visualization software;
plantuml, which can generate diagrams from UML sources. This software is only required to build the documentation.

Build galactic-algebra-kernel using the bash command

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

Use the following command to run the test suite:

$ hatch test

Use the following command to run tests with coverage:

$ hatch test --cover

Use the following command to run the doctests:

$ hatch test --doctest-modules src

Use the following command to run static checks:

$ hatch fmt --check

Use the following command to automatically fix static linting issues:

$ hatch fmt

Use the following command to run dynamic linting:

$ hatch run lint:check

Build the documentation using the bash command:

$ hatch run docs:build

Important

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