Instructions

Prerequisite

galactic 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

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

Contributing

Build

Building galactic requires

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

Build galactic using the bash command

$ hatch build

Testing

Test galactic using the bash command:

$ hatch test

for running the tests.

$ hatch test --cover

for running the tests with the coverage.

$ hatch test --doctest-modules src

for running the doctest.

Linting

Lint galactic using the bash commands:

$ hatch fmt --check

for running static linting.

$ hatch fmt

for automatic fixing of static linting issues.

$ hatch run lint:check

for running dynamic linting.

Documentation

Build the documentation using the bash commands:

$ hatch run docs:build

Getting Help

Important

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