Merge pull request #518 from RemDelaporteMathurin/dev

Merge to main

.github/ISSUE_TEMPLATE/bug-report.md

@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'

README.md

@@ -13,7 +13,6 @@ It simulates the diffusion and trapping of hydrogen, coupled to heat transfer wi
 
 :point_right: [Examples](https://github.com/RemDelaporteMathurin/FESTIM/tree/main/demos)
 
-
 ## Installation
 
 FESTIM can be installed via pip
@@ -35,7 +34,6 @@ Run the tests:
 
     pytest-3 test/
 
-
 ## Visualisation
 FESTIM results are exported to .csv, .txt or XDMF. The latter can then be opened in visualisation tools like [ParaView](https://www.paraview.org/) or [VisIt](https://wci.llnl.gov/simulation/computer-codes/visit/).
 
@@ -51,4 +49,3 @@ FESTIM results are exported to .csv, .txt or XDMF. The latter can then be opened
 - R. Delaporte-Mathurin, _et al._, _Fuel Retention in WEST and ITER Divertors Based on FESTIM Monoblock Simulations_. Nuclear Fusion 61, nᵒ 12: 126001. https://doi.org/10.1088/1741-4326/ac2bbd.
 
 - E. A. Hodille _et al._, _Modelling of Hydrogen Isotopes Trapping, Diffusion and Permeation in Divertor Monoblocks under ITER-like Conditions_. Nuclear Fusion, 2021. https://doi.org/10.1088/1741-4326/ac2abc.
-

docs/source/devguide/index.rst

@@ -29,7 +29,7 @@ Contributing to the code
 .. admonition:: Tip
    :class: tip
 
-   If you're a begginer, look for `issues tagged with "Good first issue" <https://github.com/RemDelaporteMathurin/FESTIM/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_.
+   If you're a beginner, look for `issues tagged with "Good first issue" <https://github.com/RemDelaporteMathurin/FESTIM/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_.
 
    These issues are usually fairly easy to tackle and therefore perfect for newcomers.
 
@@ -52,8 +52,8 @@ Test suite
 
 FESTIM uses continuous integration (CI) to ensure code quality and eliminate as much bugs as possible.
 
-In a nutshell, everytime a change is pushed to the repository (or to a PR), a suite of tests is automatically triggered.
-This is to make sure the changes don't break existing functionnalities.
+In a nutshell, every time a change is pushed to the repository (or to a PR), a suite of tests is automatically triggered.
+This is to make sure the changes don't break existing functionalities.
 It is also very useful to catch bugs that developers could have missed.
 Click `here <https://www.atlassian.com/continuous-delivery/continuous-integration>`_ for more information on CI.
 

docs/source/index.rst

@@ -11,7 +11,7 @@ The tool is based on the finite element methods to solve the McNabb & Foster tra
 It is capable of solving 1D/2D/3D multimaterial simulations and provides support for a wide-range of boundary conditions, which makes it a very versatile tool that can be adapted to many use cases.
 Moreover, users can rapidly get started with FESTIM thanks to its python API.
 
-FESTIM was originally developped at the `Institute for Magnetic Fusion Research (IRFM) <https://irfm.cea.fr/en/index.php>`_ and the `Process and Materials Sciences Laboratory (LSPM) <https://www.lspm.cnrs.fr/en/home/>`_.
+FESTIM was originally developed at the `Institute for Magnetic Fusion Research (IRFM) <https://irfm.cea.fr/en/index.php>`_ and the `Process and Materials Sciences Laboratory (LSPM) <https://www.lspm.cnrs.fr/en/home/>`_.
 
 
 .. admonition:: Recommended publication for citing

docs/source/userguide/settings.rst

@@ -27,6 +27,6 @@ Here you define:
 
 More advanced settings are also available:
 
-* the type of finite elements for traps (DG elements can be useful to acount for discontinuities)
+* the type of finite elements for traps (DG elements can be useful to account for discontinuities)
 * Wether to update the jacobian at each iteration or not
 * the linear solver