Instructions

Prerequisites

galactic-helper-data requires Python 3.11, a programming language that comes pre-installed on Linux and macOS, and 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, install galactic-helper-data in the same environment using:

(galactic) $ pip install galactic-helper-data

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

If you want to verify package integrity using hashes, install galactic-helper-data in the same environment with:

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

For the pre-release version, use:

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

Contributing

Build

Building galactic-helper-data requires:

• hatch, a tool for dependency management and packaging in Python.

Build galactic-helper-data using:

$ hatch build

Testing

Run the test suite with:

$ hatch test

Run tests with coverage:

$ hatch test --cover

Run doctests:

$ hatch test --doctest-modules src

Linting

Run lint checks with:

$ hatch check

Automatically fix linting issues with:

$ hatch check --fix

Documentation

Build the documentation using:

$ hatch run docs:build

Getting Help

Important

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