Skip to content

Commit

Permalink
Completed beginners guide and removed simulations.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
RemDelaporteMathurin committed Jan 16, 2024
1 parent 358128f commit 089eb96
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 15 deletions.
23 changes: 19 additions & 4 deletions docs/source/userguide/beginners_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,29 @@ What do I need to know?

To make the most out of FESTIM, a basic knowledge of `Python <https://www.learnpython.org/>`_ is required.

Depending on how you install FESTIM, new users should familiarise with either `Docker <https://www.docker.com/>`_ or `Conda <https://anaconda.org/>`_.

FESTIM is under version control with `git <https://git-scm.com/>`_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can fin `git turorials <https://git-scm.com/doc>`_ to help you getting started. The `FESTIM source code <https://github.com/RemDelaporteMathurin/FESTIM>`_ is hosted on GitHub. It is recommended to sign up for free to GitHub in order to receive the latest updates, follow the development and submit `bug reports <https://github.com/RemDelaporteMathurin/FESTIM/issues/new/choose>`_.

New users should familiarise themselves with `Conda <https://anaconda.org/>`_.

FESTIM is under version control with `git <https://git-scm.com/>`_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can fin `git turorials <https://git-scm.com/doc>`_ to help you getting started. The `FESTIM source code <https://github.com/RemDelaporteMathurin/FESTIM>`_ is hosted on GitHub. It is recommended to sign up for free to GitHub in order to receive the latest updates, follow the development and submit `bug reports <https://github.com/festim-dev/FESTIM/issues/new/choose>`_.

----------------------
Where can I find help?
----------------------

If you're having an issue, the best way to find help is to join the `FESTIM discourse <https://festim.discourse.group>`_. Engage in discussions, ask questions, and connect with other users. This is a collaborative space where you can share your experiences and seek assistance.


--------------
Install FESTIM
--------------

Follow the :ref:`installation instructions<Install>` to install FESTIM on your computer.

------------------------
Your first FESTIM script
------------------------


Follow `this tutorial <https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task1.ipynb>`_ to learn how
to run a simple 1D diffusion problem in steady state with an homogeneous temperature, a volumetric source of hydrogen,
and the concentration fixed at zero at boundaries.

1 change: 0 additions & 1 deletion docs/source/userguide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@ User's Guide
traps
settings
export_post_processing
simulations
troubleshooting
10 changes: 0 additions & 10 deletions docs/source/userguide/simulations.rst

This file was deleted.

0 comments on commit 089eb96

Please sign in to comment.