Instructions

Prerequisites

galactic-io-data-fimi 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) by following the Quick start guide.

Next, install galactic-io-data-fimi in the same environment using the following bash command:

(galactic) $ pip install "galactic-io-data-fimi[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-fimi in the same environment with one of the following bash commands:

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

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

For the pre-release version, use one of the following bash commands:

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

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

Contributing

Build

Building galactic-io-data-fimi requires

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

Build galactic-io-data-fimi using the bash commands:

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

Testing

Test galactic-io-data-fimi 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 doctest.

Linting

Lint galactic-io-data-fimi using the following bash commands:

$ hatch check

Run linting 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-io-data-fimi, please feel welcome to file an issue on GitLab so that we can help.