GALACTIC core convex package instructions

Prerequisite

galactic-core-convex 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

Using pip authentication, install galactic-core-convex using the bash command:

$ pip install \
    --index-url https://gitlab.univ-lr.fr/api/v4/groups/galactic/-/packages/pypi/simple \
    galactic-core-convex[docs]

The docs extra needs an install of graphviz. Don’t forget to add the --pre flag if you want the latest unstable build.

Contributing

Build

Building galactic-core-convex requires

hatch, which is a tool for dependency management and packaging in Python;
graphviz, which is a graph visualization software;

Build galactic-core-convex using the bash command

$ hatch build

Testing

Test galactic-core-convex using the bash commands:

$ GITLAB_TOKEN=<your personal access token> hatch test

for running the tests.

$ GITLAB_TOKEN=<your personal access token> hatch test --cover

for running the tests with the coverage.

$ GITLAB_TOKEN=<your personal access token> hatch test --doctest-modules src

for running the doctest.

Linting

Lint galactic-core-convex 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 command:

$ hatch run docs:build

Getting Help

Important

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