Metadata-Version: 2.4
Name: open-darts
Version: 1.4.0
Summary: Open Delft Advanced Research Terra Simulator
Author-email: Denis Voskov <D.V.Voskov@tudelft.nl>
Maintainer-email: Ilshat Saifullin <i.s.saifullin@tudelft.nl>
License-Expression: GPL-3.0-or-later
Project-URL: homepage, https://darts.citg.tudelft.nl/
Project-URL: repository, https://gitlab.com/open-darts/open-darts
Project-URL: documentation, https://open-darts.readthedocs.io/en/docs
Keywords: energy transition,modeling of CO2 sequestration,geothermal energy production
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: C++
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE.md
Requires-Dist: numba
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: meshio
Requires-Dist: gmsh<=4.13
Requires-Dist: iapws
Requires-Dist: openpyxl
Requires-Dist: pyevtk
Requires-Dist: matplotlib
Requires-Dist: vtk
Requires-Dist: shapely
Requires-Dist: igraph
Requires-Dist: sympy
Requires-Dist: opmcpg
Requires-Dist: xarray
Requires-Dist: netCDF4==1.7.2
Requires-Dist: h5py==3.14.0
Requires-Dist: open-darts-flash==0.11.1
Requires-Dist: phreeqpy
Provides-Extra: docs
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-tabs; extra == "docs"
Requires-Dist: sphinx_inline_tabs; extra == "docs"
Requires-Dist: sphinxcontrib-matlabdomain; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Requires-Dist: linkify-it-py; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: solvers
Requires-Dist: pypardiso; extra == "solvers"
Dynamic: license-file



[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8046982.svg)](https://doi.org/10.5281/zenodo.8046982) [![Latest Release](https://gitlab.com/open-darts/open-darts/-/badges/release.svg)](https://gitlab.com/open-darts/open-darts/-/releases) [![pipeline status](https://gitlab.com/open-darts/open-darts/badges/development/pipeline.svg)](https://gitlab.com/open-darts/open-darts/-/commits/development) [![pypi](https://img.shields.io/pypi/v/open-darts.svg?colorB=blue)](https://pypi.python.org/project/open-darts/)
[![RSD](https://img.shields.io/badge/rsd-openDARTS-00a3e3.svg)](https://research-software-directory.org/software/opendarts)

# openDARTS

[openDARTS](https://darts.citg.tudelft.nl/) is a scalable parallel modeling framework and aims to accelerate the simulation performance while capturing multi-physics processes in geo-engineering fields such as hydrocarbon, geothermal, CO2 sequestration and hydrogen storage.

## Installation

openDARTS with direct linear solvers can be installed from PyPI:

```bash
pip install open-darts
```

Models that rely on PHREEQC/Reaktoro chemistry backends need the optional third-party stack. Activate the Conda environment you use for development, install Reaktoro via `conda install -c conda-forge reaktoro` (see the [official guide](https://reaktoro.org/installation/installation-using-conda.html)), and invoke `./helper_scripts/build_darts_cmake.sh -p` (or the `.bat` variant on Windows) to build the accompanying iPHREEQC libraries.

openDARTS is available for Python 3.9 to 3.12 for x86_64 architecture both for Linux and Windows.

To build openDARTS please check the [instructions in our wiki](https://gitlab.com/open-darts/open-darts/-/wikis/Build-instructions).

## Tutorials

Check the [tutorial section in the documentation](https://open-darts.gitlab.io/open-darts/getting_started/tutorial.html) and Jupyter Notebooks with basic [Geothermal](https://gitlab.com/open-darts/darts-models/-/tree/main/teaching/EAGE?ref_type=heads) and [GCS](https://gitlab.com/open-darts/darts-models/-/tree/main/teaching/CCS_workshop?ref_type=heads) models.

Also to get started take a look at the different examples in [models](https://gitlab.com/open-darts/open-darts/-/tree/development/models?ref_type=heads).

More advanced examples of complex simulations with openDARTS can be found in [open-darts-models](https://gitlab.com/open-darts/open-darts-models).

## Documentation

For more information about how to get started visit the [documentation](https://open-darts.gitlab.io/open-darts/).

## License

Please refer to [LICENSE.md](LICENSE.md) for information about the licensing of openDARTS.

## Information

The [wiki](https://gitlab.com/open-darts/open-darts/-/wikis/home) contains information for developing cycle, in particular [Build instructions](https://gitlab.com/open-darts/open-darts/-/wikis/Build-instructions).

## How to cite

If you use open-DARTS in your research, we ask you to cite the following publication

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8046982.svg)](https://doi.org/10.5281/zenodo.8046982)

## Contribution

Check [how to contribute](https://gitlab.com/open-darts/open-darts/-/wikis/Contributing)
