Instructions

Prerequisite

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

(galactic) $ pip install "galactic-algebra-convex[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-convex in the same environment with one of the following bash commands:

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

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

and for the pre-release version with one of the following bash commands:

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

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

Contributing

Build

Building galactic-algebra-convex requires

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

• graphviz, which is a graph visualization software;

Build galactic-algebra-convex using the bash command:

$ hatch build

Testing

Test galactic-algebra-convex using the bash command:

$ hatch test

For running the tests.

$ hatch test --cover

For running the tests with coverage.

$ hatch test --doctest-modules src

For running the doctests.

Linting

Lint galactic-algebra-convex using the bash commands:

$ hatch check

For running linting.

$ hatch check --fix

For automatically fixing linting issues.

Documentation

Build the documentation using the bash commands:

$ hatch run docs:build

Getting Help

Important

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