Instructions

Prerequisites

galactic-description-category-basic requires python 3.11, a programming language that comes pre-installed on Linux and macOS, and which is easy to install on Windows;

Installation

First, install galactic in a virtual environment (conda or venv) using the instructions in the Quick start guide.

Then install galactic-description-category-basic in the same environment with the following bash command:

(galactic) $ pip install "galactic-description-category-basic[docs]"

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

If you want to verify package integrity using hashes, you can install galactic-description-category-basic in the same environment with one of the following bash commands:

(galactic) $ pip install -r https://www.thegalactic.org/requirements/stable/galactic-description-category-basic.txt

(galactic) $ pip install -r https://www.thegalactic.org/requirements/stable/galactic-description-category-basic_docs.txt

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

(galactic) $ pip install -r https://www.thegalactic.org/requirements/pre/galactic-description-category-basic.txt

(galactic) $ pip install -r https://www.thegalactic.org/requirements/pre/galactic-description-category-basic_docs.txt

Contributing

Build

Building galactic-description-category-basic requires

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

• graphviz, which is a graph visualization tool;

Build galactic-description-category-basic with the following bash command:

$ hatch build

Testing

Test galactic-description-category-basic with the following bash command:

$ hatch test

to run the tests.

$ hatch test --cover

to run the tests with coverage.

$ hatch test --doctest-modules src

to run the doctests.

Linting

Lint galactic-description-category-basic with the following bash commands:

$ hatch check

to run linting.

$ hatch check --fix

to automatically fix linting issues.

Documentation

Build the documentation with the following bash command:

$ hatch run docs:build

Getting Help

Important

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