arctix

Overview

TODO

• Motivation
• Documentation
• Installation
• Contributing
• API stability
• License

Motivation

TODO

Installation

We highly recommend installing a virtual environment. arctix can be installed from pip using the following command:

pip install arctix

To make the package as slim as possible, only the minimal packages required to use arctix are installed. To include all the packages, you can use the following command:

pip install arctix[all]

Please check the get started page to see how to install only some specific packages or other alternatives to install the library.

Contributing

Please check the instructions in CONTRIBUTING.md.

API stability

:warning: While arctix is in development stage, no API is guaranteed to be stable from one release to the next. In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release. In practice, this means that upgrading arctix to a new version will possibly break any code that was using the old version of arctix.

License

arctix is licensed under BSD 3-Clause "New" or "Revised" license available in LICENSE file.