From 4f8ed88dce739846132a2ba1d2c2f6adbbc41a92 Mon Sep 17 00:00:00 2001 From: kaelyndunnell Date: Fri, 11 Oct 2024 16:56:48 -0400 Subject: [PATCH 1/7] Removed out of date line in docstrings addressing issue #684 --- festim/hydrogen_transport_problem.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/festim/hydrogen_transport_problem.py b/festim/hydrogen_transport_problem.py index 7f5d6a981..3bf1148cf 100644 --- a/festim/hydrogen_transport_problem.py +++ b/festim/hydrogen_transport_problem.py @@ -23,7 +23,6 @@ class HydrogenTransportProblem(F.ProblemBase): of the model boundary_conditions (list of festim.BoundaryCondition): the boundary conditions of the model - solver_parameters (dict): the solver parameters of the model exports (list of festim.Export): the exports of the model traps (list of F.Trap): the traps of the model @@ -39,7 +38,6 @@ class HydrogenTransportProblem(F.ProblemBase): of the model boundary_conditions (list of festim.BoundaryCondition): the boundary conditions of the model - solver_parameters (dict): the solver parameters of the model exports (list of festim.Export): the exports of the model traps (list of F.Trap): the traps of the model dx (dolfinx.fem.dx): the volume measure of the model From 1ff95e9dd1f8da93d35d710cf9f0c7ce0717e9f4 Mon Sep 17 00:00:00 2001 From: kaelyndunnell Date: Fri, 11 Oct 2024 17:05:03 -0400 Subject: [PATCH 2/7] Updated What do I need to Know section of user guide to reflect that a git account is not needed for latest updates of the code. --- docs/source/userguide/beginners_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst index ec5886a8e..7d0a9ed3b 100644 --- a/docs/source/userguide/beginners_guide.rst +++ b/docs/source/userguide/beginners_guide.rst @@ -10,7 +10,7 @@ To make the most out of FESTIM, a basic knowledge of `Python `_ or `Conda `_. -FESTIM is under version control with `git `_. 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 `_ to help you getting started. The `FESTIM source code `_ 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 `_. +FESTIM is under version control with `git `_. 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 `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Git knowledge and a GitHub account is required to open issues and contribute to the code. ---------------------- Where can I find help? From 84aca0ea74b5f8f0fa5884abc4f33bf7434f7845 Mon Sep 17 00:00:00 2001 From: kaelyndunnell Date: Thu, 17 Oct 2024 21:13:27 -0400 Subject: [PATCH 3/7] Close progress bar after simu runs --- festim/problem.py | 1 + 1 file changed, 1 insertion(+) diff --git a/festim/problem.py b/festim/problem.py index 582ea6385..da5510892 100644 --- a/festim/problem.py +++ b/festim/problem.py @@ -121,6 +121,7 @@ def run(self): # Solve steady-state self.solver.solve(self.u) self.post_processing() + self.progress_bar.close() def iterate(self): """Iterates the model for a given time step""" From 6ee9cd9893a9f4a1bfc26f1411082a6543210c47 Mon Sep 17 00:00:00 2001 From: kaelyndunnell Date: Mon, 4 Nov 2024 11:14:05 -0500 Subject: [PATCH 4/7] added link to devguide for contribute to code section of doc; moved self.progress_bar.close() to pass CI --- docs/source/userguide/beginners_guide.rst | 2 +- festim/problem.py | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst index 7d0a9ed3b..327f253ab 100644 --- a/docs/source/userguide/beginners_guide.rst +++ b/docs/source/userguide/beginners_guide.rst @@ -10,7 +10,7 @@ To make the most out of FESTIM, a basic knowledge of `Python `_ or `Conda `_. -FESTIM is under version control with `git `_. 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 `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Git knowledge and a GitHub account is required to open issues and contribute to the code. +FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can find `git turorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Git knowledge and a GitHub account is required to open issues and `contribute to the code. `_ ---------------------- Where can I find help? diff --git a/festim/problem.py b/festim/problem.py index da5510892..c518c7b65 100644 --- a/festim/problem.py +++ b/festim/problem.py @@ -117,11 +117,12 @@ def run(self): self.iterate() if self.show_progress_bar: self.progress_bar.refresh() # refresh progress bar to show 100% + self.progress_bar.close() else: # Solve steady-state self.solver.solve(self.u) self.post_processing() - self.progress_bar.close() + def iterate(self): """Iterates the model for a given time step""" From 134382d4fd6eed3938e331c697199bfa3a51359e Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Mon, 4 Nov 2024 13:26:32 -0500 Subject: [PATCH 5/7] sames fixes as in main --- docs/source/devguide/index.rst | 2 ++ docs/source/userguide/beginners_guide.rst | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/devguide/index.rst b/docs/source/devguide/index.rst index 064f770d3..734ceea43 100644 --- a/docs/source/devguide/index.rst +++ b/docs/source/devguide/index.rst @@ -1,3 +1,5 @@ +.. _developers_guide: + ================= Developer's Guide ================= diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst index 327f253ab..8020a670c 100644 --- a/docs/source/userguide/beginners_guide.rst +++ b/docs/source/userguide/beginners_guide.rst @@ -10,7 +10,7 @@ To make the most out of FESTIM, a basic knowledge of `Python `_ or `Conda `_. -FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can find `git turorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Git knowledge and a GitHub account is required to open issues and `contribute to the code. `_ +FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can find `git tutorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Git knowledge and a GitHub account is required to open issues and :ref:`contribute to the code `. ---------------------- Where can I find help? From b37b78daad4895f205e81220d48ed5dd248f3e14 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Mon, 4 Nov 2024 13:27:31 -0500 Subject: [PATCH 6/7] ruff formating --- src/festim/problem.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/festim/problem.py b/src/festim/problem.py index 76026ec52..47ded7cee 100644 --- a/src/festim/problem.py +++ b/src/festim/problem.py @@ -159,7 +159,6 @@ def run(self): # Solve steady-state self.solver.solve(self.u) self.post_processing() - def iterate(self): """Iterates the model for a given time step""" From 7a770bce4cf54548edefac7916c6b08507cf2352 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Mon, 4 Nov 2024 13:27:59 -0500 Subject: [PATCH 7/7] correct indent --- src/festim/problem.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/festim/problem.py b/src/festim/problem.py index 47ded7cee..d1066ef79 100644 --- a/src/festim/problem.py +++ b/src/festim/problem.py @@ -154,7 +154,7 @@ def run(self): self.iterate() if self.show_progress_bar: self.progress_bar.refresh() # refresh progress bar to show 100% - self.progress_bar.close() + self.progress_bar.close() else: # Solve steady-state self.solver.solve(self.u)