Skip to content

Commit

Permalink
Merge pull request #709 from RemDelaporteMathurin/update-README
Browse files Browse the repository at this point in the history
Add roadmap to README and change layout
  • Loading branch information
RemDelaporteMathurin authored Mar 20, 2024
2 parents 164a829 + a6d0db2 commit dde42a7
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,29 @@
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).

:point_right: [Installation](https://festim.readthedocs.io/en/latest/installation.html)

:point_right: [Documentation](https://festim.readthedocs.io/)
## Getting started

:point_right: [Tutorials](https://github.com/festim-dev/FESTIM-workshop)
The installation instructions are available [here](https://festim.readthedocs.io/en/latest/installation.html).

### Forum
## Documentation

Join the FESTIM community on our [Discourse Forum](https://festim.discourse.group/).
Documentation can be viewed at https://festim.readthedocs.io/

## References
- R. Delaporte-Mathurin, _et al._, _Finite Element Analysis of Hydrogen Retention in ITER Plasma Facing Components using FESTIM_. Nuclear Materials and Energy, 21, (2019). https://doi.org/10.1016/j.nme.2019.100709.
## Tutorials

- R. Delaporte-Mathurin, _et al._, _Parametric Study of Hydrogenic Inventory in the ITER Divertor Based on Machine Learning_. Scientific Reports, 10, (2020). https://doi.org/10.1038/s41598-020-74844-w.
Visit the FESTIM-workshop to view the available tutorials https://github.com/festim-dev/FESTIM-workshop

- J. Dark, _et al._, _Influence of hydrogen trapping on WCLL breeding blanket performances_. Nuclear Fusion, 62, (2021). https://doi.org/10.1088/1741-4326/ac28b0.
## Contact

For full list of publications using FESTIM see the [publications](https://festim.readthedocs.io/en/latest/publications.html) section in the docs
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

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

## Roadmap

Join our [Slack](https://join.slack.com/t/festimworkspace/shared_invite/zt-246hw8d6o-htWASLsbdosUo_2nRKCf9g) channel
You can follow the public roadmap on the [FESTIM projects page](https://github.com/festim-dev/FESTIM/projects?query=is%3Aopen).
Moreover, you can check out the development branch (with support of FEniCSx) on the [_fenicsx_](https://github.com/festim-dev/FESTIM/tree/fenicsx) branch.

0 comments on commit dde42a7

Please sign in to comment.