Metadata-Version: 2.4
Name: eikos
Version: 0.0.0
Summary: Data model to manage numerical unceirtainty
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
Provides-Extra: dev
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"

eikos
=======================================
.. image:: https://img.shields.io/badge/linter-ruff-261230.svg
   :target: https://github.com/astral-sh/ruff

Data model to manage numerical Uncertainty

Installation
------------

Create a dedicated python environment for this package with your favorite environment manager.

.. code-block:: shell

   conda create -n eikos python=3.11
   conda activate eikos


* Option 1: Install the package from the git repository:

.. code-block:: shell

   pip install git+ssh://git@gitlab.com/syngentagroup/cas/dev/eikos.git

* Option 2: Install the package from the python package repository if its url is configured in the pip configuration file:

.. code-block:: shell

   pip install eikos


For Development
---------------

When working on the development of this package, the developer wants to work
directly on the source code while still using the packaged installation. For
that, run:

.. code-block:: shell

   git clone git@gitlab.com:syngentagroup/cas/dev/eikos.git
   cd eikos
   conda create -n eikos python=3.11
   conda activate eikos
   pip install -e .[dev]

Run the linting and formatting tools:

.. code-block:: shell

   ruff check src/ tests/     # lint
   ruff format src/ tests/    # format

Install pre-commit hooks:

.. code-block:: shell

   pre-commit install
