Metadata-Version: 2.1
Name: jinns
Version: 0.1.0
Summary: Physics Informed Neural Network with JAX
Author-email: Hugo Gangloff <hugo.gangloff@inrae.fr>, Nicolas Jouvin <nicolas.jouvin@inrae.fr>
Maintainer-email: Hugo Gangloff <hugo.gangloff@inrae.fr>, Nicolas Jouvin <nicolas.jouvin@inrae.fr>
License: Apache License 2.0
Project-URL: Repository, https://gitlab.com/mia_jinns/jinns
Project-URL: Documentation, https://mia_jinns.gitlab.io/jinns/index.html
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: jax
Requires-Dist: jaxopt
Requires-Dist: optax
Requires-Dist: equinox
Requires-Dist: jax-tqdm
Provides-Extra: notebook
Requires-Dist: jupyter ; extra == 'notebook'
Requires-Dist: matplotlib ; extra == 'notebook'

jinns
=====

# Installation

Install the latest version with pip 

```bash 
pip install jinns
```

# Documentation

The project's documentation is available at [https://mia_jinns.gitlab.io/jinns/index.html](https://mia_jinns.gitlab.io/jinns/index.html)

# Contributing

* First fork the library on Gitlab.

* Then clone and install the library in development mode with 

```bash
pip install -e .
```

* Install pre-commit and run it.

```bash
pip install pre-commit
pre-commit install
```

* Open a merge request once you are done with your changes.

# Contributors & references

*Active*: Hugo Gangloff, Nicolas Jouvin
*Past*: Pierre Gloaguen, Charles Ollion, Achille Thin

