Metadata-Version: 2.1
Name: valjean
Version: 0.11.0
Summary: VALidation, Journal d'Évolution et ANalyse
Home-page: https://github.com/valjean-framework/valjean
License: CeCILL-C Free Software License Agreement (CECILL-C)
Author: valjean developers
Maintainer: valjean developers
Maintainer-email: valjean-support@cea.fr
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Provides-Extra: dev
Provides-Extra: graphviz
Requires-Dist: Sphinx (>=7.1,<8.0) ; extra == "dev"
Requires-Dist: flake8 (>=7.1,<8.0) ; extra == "dev"
Requires-Dist: h5py (>=3.11,<4.0)
Requires-Dist: hypothesis (>=6.112,<7.0) ; extra == "dev"
Requires-Dist: ipykernel (>=6.29,<7.0) ; extra == "dev"
Requires-Dist: ipython (>=8.12,<9.0) ; extra == "dev"
Requires-Dist: jupyter-client (>=8.6,<9.0) ; extra == "dev"
Requires-Dist: matplotlib (>=3.7,<4.0)
Requires-Dist: nbsphinx (>=0.9,<0.10) ; extra == "dev"
Requires-Dist: numpy (>=1.24,<2.0)
Requires-Dist: pydot (>=3.0,<4.0) ; extra == "graphviz"
Requires-Dist: pylint (>=3.2,<4.0) ; extra == "dev"
Requires-Dist: pyparsing (>=3.1,<4.0)
Requires-Dist: pytest (>=8.3,<9.0) ; extra == "dev"
Requires-Dist: pytest-cov (>=5.0,<6.0) ; extra == "dev"
Requires-Dist: pytest-mpl (>=0.17,<0.18) ; extra == "dev"
Requires-Dist: pytest-timeout (>=2.3,<3.0) ; extra == "dev"
Requires-Dist: rstcheck (>=6.0,<7.0) ; extra == "dev"
Requires-Dist: scipy (>=1.10,<2.0)
Requires-Dist: sphinx-rtd-theme (>=2.0,<3.0) ; extra == "dev"
Requires-Dist: toml (>=0.10,<0.11)
Project-URL: Bug tracker, https://github.com/valjean-framework/valjean/issues
Project-URL: Documentation, https://valjean.readthedocs.io/
Project-URL: Repository, https://github.com/valjean-framework/valjean.git
Description-Content-Type: text/markdown

# Valjean #

Quick installation guide:

*valjean* needs at least python3.8 and is tested up to python 3.12.

## Installation using *pip* ##

### Setup a virtual environment ###

```
python3 -m venv MY_VIRTUAL_ENV
source MY_VIRTUAL_ENV/bin/activate
pip install -U pip
```

### Installation from git ###

```
git clone https://github.com/valjean-framework/valjean.git
pip install ./valjean  # or pip install path/to/valjean
```

### Installation from archive ###

The pip archive can be downloaded from the *Fichiers*/*Files* area of Tuleap.

```
pip install valjean-VERSION.tar.gz
```


## Installation using *conda* ##

1. Download and install *conda*.
2. Download the *valjean-conda* archive from the *Fichiers*/*Files* area of
   Tuleap.
3. Install *valjean*:

```
source MY_CONDA/bin/activate
conda create -n MY_ENV python=PY_VERSION
conda activate MY_ENV
conda install -c file://PATH/TO/valjean-VERSION.tar.bz2 --use-local valjean
```

The python version of *conda* should be the same as the one used to build the
*valjean* archive.

This installation is not foreseen for development.


## Documentation ##

The documentation can be found online: https://valjean.readthedocs.io/en/latest/

It can also be downloaded from the *Fichiers*/*Files* area of Tuleap.

```
tar xzf valjean-doc-*.tar.gz
```

You can also consult the source files for the documentation in the ``doc/src``
directory.

