Instructions

Prerequisites

galactic-io-data-toon 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-io-data-toon in the same environment using the bash command:

(galactic) $ pip install "galactic-io-data-toon[docs]"

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-io-data-toon in the same environment with one of the following bash commands:

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

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

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

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

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

Contributing

Build

Building galactic-io-data-toon requires

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

Build galactic-io-data-toon using the bash command:

$ hatch run docs:notebooks [--overwrite]
$ hatch build

Testing

Run the tests using the bash command:

$ hatch test

Run the tests with coverage using the bash command:

$ hatch test --cover

Run the doctests using the bash command:

$ hatch test --doctest-modules src

Linting

Run linting using the bash command:

$ hatch check

Automatically fix linting issues using the bash command:

$ hatch check --fix

Documentation

Build the documentation using the bash command:

$ hatch run docs:build

Getting Help

Important

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