Metadata-Version: 2.4
Name: FESTIM
Version: 2.0
Summary: Finite element simulations of hydrogen transport
Author: Remi Delaporte-Mathurin
Author-email: rdelaportemathurin@gmail.com
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/festim-dev/FESTIM
Project-URL: Issues, https://github.com/festim-dev/FESTIM/issues
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
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: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tqdm
Requires-Dist: scifem>=0.2.13
Requires-Dist: adios4dolfinx
Provides-Extra: test
Requires-Dist: pytest>=5.4.3; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: sympy; extra == "test"
Requires-Dist: ipyparallel; extra == "test"
Provides-Extra: lint
Requires-Dist: ruff; extra == "lint"
Requires-Dist: mypy; extra == "lint"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: matplotlib; extra == "docs"
Dynamic: license-file

# FESTIM
[![NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org/)
[![Conda CI](https://github.com/festim-dev/FESTIM/actions/workflows/ci_conda.yml/badge.svg?branch=main)](https://github.com/festim-dev/FESTIM/actions/workflows/ci_conda.yml)
[![Docker CI](https://github.com/festim-dev/FESTIM/actions/workflows/ci_docker.yml/badge.svg?branch=main)](https://github.com/festim-dev/FESTIM/actions/workflows/ci_docker.yml)
[![codecov](https://codecov.io/gh/festim-dev/FESTIM/branch/main/graph/badge.svg?token=AK3A9CV2D3)](https://codecov.io/gh/festim-dev/FESTIM)
[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
![GitHub stars](https://img.shields.io/github/stars/festim-dev/FESTIM.svg?logo=github&label=Stars&logoColor=white)
![GitHub forks](https://img.shields.io/github/forks/festim-dev/FESTIM.svg?logo=github&label=Forks&logoColor=white)

FESTIM (Finite Elements Simulation of Tritium in Materials) is a tool for modeling hydrogen transport in materials. 
It simulates the diffusion and trapping of hydrogen, coupled to heat transfer with [FEniCS](https://fenicsproject.org).


## Getting started

The installation instructions are available [here](https://festim.readthedocs.io/en/latest/installation.html).

## Documentation 

Documentation can be viewed at https://festim.readthedocs.io/

## Tutorials

Visit the FESTIM-workshop to view the available tutorials https://github.com/festim-dev/FESTIM-workshop

## Contact

For questions on how to use FESTIM, visit our [Discourse page](https://festim.discourse.group/)
or join our [Slack](https://join.slack.com/t/festimworkspace/shared_invite/zt-246hw8d6o-htWASLsbdosUo_2nRKCf9g) channel

## Contributing

The guidelines for contributions can be found in the documentation: https://festim.readthedocs.io/en/latest/devguide/index.html

## Roadmap

You can follow the public roadmap on the [FESTIM projects page](https://github.com/festim-dev/FESTIM/projects?query=is%3Aopen).
