Install the GALACTIC io data core package

Prerequisite

galactic-io-data-core requires python 3.10, a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed on Windows;

Installation

Install galactic-io-data-core using the bash command

$ pip install \
    --index-url https://gitlab.univ-lr.fr/api/v4/groups/galactic/-/packages/pypi/simple \
    galactic-io-data-core

Build

Building galactic-io-data-core requires

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

Build galactic-io-data-core using the bash command

$ poetry install --with docs
$ poetry build

Documentation

Build the documentation using the bash commands:

$ poetry install --all-extras --with docs
$ poetry run towncrier build --keep
$ poetry run sphinx-build docs/ build/sphinx/html/
$ git checkout HEAD -- docs/release-notes.rst

Testing

Test galactic-io-data-core using the bash command:

$ poetry run tox
$ poetry run tox -e style
$ poetry run tox -e linter

Getting Help

Important

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