galactic-helper-core 0.5.0.0

GALACTIC helper core

Prerequisites

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

(galactic) $ pip install galactic-helper-core

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-core in the same environment with the following bash command:

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

and for the pre-release version with the following bash command:

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

Contributing

Build

Building galactic-helper-core requires

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

Build galactic-helper-core using the bash command:

$ hatch build

Testing

Test galactic-helper-core 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-helper-core using the bash commands:

$ hatch check

for running linting.

$ hatch check

for automatic fixing of linting issues.

Documentation

Build the documentation using the bash command:

$ hatch run docs:build

Getting Help

Important

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