Metadata-Version: 2.4
Name: pyrtid
Version: 0.2.0
Summary: Reactive Transport Inversion demonstrator written in Python.
Author-email: Antoine Collet <antoinecollet5@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2024-2026, Antoine COLLET
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://pypi.org/project/pyrtid/
Project-URL: Documentation, https://pyrtid.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/antoinecollet5/pyrtid
Project-URL: Issues, https://github.com/antoinecollet5/pyrtid/issues
Project-URL: Changelog, https://github.com/antoinecollet5/pyrtid/blob/master/CHANGELOG.rst
Keywords: Inversion,Gradient descent,Reactive transport,Parameters estimation,Adjoint State,Demonstrator
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: gstools
Requires-Dist: typing_extensions
Requires-Dist: pyesmda
Requires-Dist: stochopy
Requires-Dist: iterative_ensemble_smoother
Requires-Dist: matplotlib
Requires-Dist: joblib
Requires-Dist: nested_grid_plotter
Requires-Dist: lbfgsb
Requires-Dist: numba
Requires-Dist: scooby; python_version >= "3.10"
Provides-Extra: all
Requires-Dist: pyrtid[docs,examples,install,lint,sparse,tests]; extra == "all"
Provides-Extra: sparse
Requires-Dist: scikit-sparse; extra == "sparse"
Provides-Extra: docs
Requires-Dist: sphinx<9; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: nbsphinx-link>=1.3.1; extra == "docs"
Requires-Dist: jupyter_sphinx>=0.3.2; extra == "docs"
Requires-Dist: sphinx-jsonschema>=1.15; extra == "docs"
Requires-Dist: pygments>=2.11.1; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Provides-Extra: tests
Requires-Dist: twine==1.14.0; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-runner; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-cookies; extra == "tests"
Requires-Dist: coverage; extra == "tests"
Requires-Dist: numdifftools; extra == "tests"
Provides-Extra: examples
Requires-Dist: numdifftools; extra == "examples"
Requires-Dist: gstlearn; extra == "examples"
Requires-Dist: pyvista[all]; extra == "examples"
Requires-Dist: ipykernel; extra == "examples"
Requires-Dist: shapely; extra == "examples"
Requires-Dist: tomli; extra == "examples"
Provides-Extra: lint
Requires-Dist: pre-commit; extra == "lint"
Requires-Dist: codespell>=2.1.0; extra == "lint"
Requires-Dist: ruff; extra == "lint"
Requires-Dist: ty; extra == "lint"
Provides-Extra: install
Requires-Dist: pip; extra == "install"
Requires-Dist: wheel; extra == "install"
Dynamic: license-file

======
pyRTID
======

|License| |Stars| |Python| |PyPI| |Downloads| |Build Status| |Documentation Status| |Coverage| |Codacy| |Precommit: enabled| |Ruff| |ty| |DOI|

The Python Reactive Transport Inversion Demonstrator.

Reactive Transport Inversion is a reactive transport inversion demonstrator written in Python.

🏗️ Complete example with supporting paper coming Q1 2026.

===========
🔑 License
===========

This project is released under the **BSD 3-Clause License**.

Copyright (c) 2024-2026, Antoine COLLET. All rights reserved.

For more details, see the `LICENSE <https://github.com/antoinecollet5/pyrtid/blob/master/LICENSE>`_ file included in this repository.

==============
⚠️ Disclaimer
==============

This software is provided "as is", without warranty of any kind, express or implied,
including but not limited to the warranties of merchantability, fitness for a particular purpose,
or non-infringement. In no event shall the authors or copyright holders be liable for
any claim, damages, or other liability, whether in an action of contract, tort,
or otherwise, arising from, out of, or in connection with the software or the use
or other dealings in the software.

By using this software, you agree to accept full responsibility for any consequences,
and you waive any claims against the authors or contributors.

==========
📧 Contact
==========

For questions, suggestions, or contributions, you can reach out via:

- Email: antoinecollet5@gmail.com
- GitHub: https://github.com/antoinecollet5/pyrtid

We welcome contributions!

=============
📚 References
=============

[1] Antoine Collet. Assisted history matching in reactive transport :
Application to uranium in situ recovery. Environmental Engineering.
Université Paris sciences et lettres, 2024. English. ⟨NNT : 2024UPSLM064⟩. ⟨tel-05097765⟩

[2] Antoine Collet, Irina Sin, Hervé Chauris, Valérie Langlais, Olivier Regnault,
Impact of time and spatial discretization on adjoint operators:
Example of stationary and transient saturated flows,
Advances in Water Resources, Volume 205, 2025, 105070,
ISSN 0309-1708, https://doi.org/10.1016/j.advwatres.2025.105070.

* Free software: SPDX-License-Identifier: BSD-3-Clause


.. |License| image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
    :target: https://github.com/antoinecollet5/lbfgsb/blob/master/LICENSE

.. |Stars| image:: https://img.shields.io/github/stars/antoinecollet5/pyrtid.svg?style=social&label=Star&maxAge=2592000
    :target: https://github.com/antoinecollet5/pyrtid/stargazers
    :alt: Stars

.. |Python| image:: https://img.shields.io/pypi/pyversions/pyrtid.svg
    :target: https://pypi.org/pypi/pyrtid
    :alt: Python

.. |PyPI| image:: https://img.shields.io/pypi/v/pyrtid.svg
    :target: https://pypi.org/pypi/pyrtid
    :alt: PyPI

.. |Downloads| image:: https://static.pepy.tech/badge/pyrtid
    :target: https://pepy.tech/project/pyrtid
    :alt: Downoads


.. |Build Status| image:: https://github.com/antoinecollet5/pyrtid/actions/workflows/main.yml/badge.svg
    :target: https://github.com/antoinecollet5/pyrtid/actions/workflows/main.yml
    :alt: Build Status

.. |Documentation Status| image:: https://readthedocs.org/projects/pyrtid/badge/?version=latest
    :target: https://pyrtid.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |Coverage| image:: https://codecov.io/gh/antoinecollet5/pyrtid/branch/master/graph/badge.svg?token=ISE874MMOF
    :target: https://codecov.io/gh/antoinecollet5/pyrtid
    :alt: Coverage

.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/de7e2aa515894571aa2bbb43c33ada2c
    :target: https://app.codacy.com/gh/antoinecollet5/pyrtid/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
    :alt: codacy

.. |Precommit: enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
   :target: https://github.com/pre-commit/pre-commit

.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff

.. |ty| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json
    :target: https://github.com/astral-sh/ty
    :alt: Checked with ty

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8192031.svg
   :target: https://doi.org/10.5281/zenodo.8192031
