Instructions

Prerequisites

galactic-helper-resource requires python 3.11, a programming language that comes pre-installed on Linux and macOS and is easy to install 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-helper-resource in the same environment using the following Bash command:

(galactic) $ pip install galactic-helper-resource

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-helper-resource in the same environment with the following Bash command:

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

For the pre-release version, use the following Bash command:

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

Contributing

Build

Building galactic-helper-resource requires:

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

Build galactic-helper-resource using the following Bash command:

$ hatch build

Testing

Test galactic-helper-resource using the following Bash commands:

$ hatch test

Run the test suite.

$ hatch test --cover

Run the test suite with coverage.

$ hatch test --doctest-modules src

Run doctests.

Linting

Lint galactic-helper-resource using the following Bash commands:

$ hatch check

Run lint checks.

$ hatch check --fix

Automatically fix linting issues.

Documentation

Build the documentation using the following Bash command:

$ hatch run docs:build

Getting Help

Important

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