Instructions

Prerequisite

galactic-io-data-fimi requires python 3.11, a programming language that comes pre-installed on linux and Mac OS X, 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-fimi in the same environment using the 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.

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 command

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

Testing

Test galactic-io-data-fimi 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-io-data-fimi using the bash commands:

$ hatch fmt --check

for running static linting.

$ hatch fmt

for automatic fixing of static linting issues.

$ hatch run lint:check

for running dynamic linting.

Documentation

Build the documentation using the bash commands:

$ 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.