fixed typo attributes

festim-dev · Jul 3, 2024 · d2f54d1 · d2f54d1
1 parent f1f9a71
commit d2f54d1
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 5 deletions.
diff --git a/festim/exports/derived_quantities/derived_quantities.py b/festim/exports/derived_quantities/derived_quantities.py
@@ -25,6 +25,18 @@ class DerivedQuantities(list):
             exported at the last timestep. Defaults to None.
         show_units (bool, optional): will show the units of each
             derived quantity in the title in export
+
+    Attributes:
+        filename (str): the filename.
+        nb_iterations_between_compute (int): number of
+            iterations between each derived quantities computation.
+        nb_iterations_between_exports (int): number of
+            iterations between each export. If None, the file will be
+            exported at the last timestep.
+        show_units (bool): will show the units of each
+            derived quantity in the title in export
+        data (list): the data to be exported
+        t (list): the time steps
     """
 
     def __init__(

diff --git a/festim/exports/derived_quantities/hydrogen_flux.py b/festim/exports/derived_quantities/hydrogen_flux.py
@@ -8,7 +8,7 @@ class HydrogenFlux(SurfaceFlux):
     Args:
         surface (int): the surface id
 
-    Attribtutes
+    Attributes:
         field (str): the hydrogen solute field
         surface (int): the surface id
         title (str): the title of the derived quantity

diff --git a/festim/exports/derived_quantities/surface_flux.py b/festim/exports/derived_quantities/surface_flux.py
@@ -11,7 +11,7 @@ class SurfaceFlux(SurfaceQuantity):
         field (str, int):  the field ("solute", 0, 1, "T", "retention")
         surface (int): the surface id
 
-    Attribtutes
+    Attributes:
         field (str, int):  the field ("solute", 0, 1, "T", "retention")
         surface (int): the surface id
         export_unit (str): the unit of the derived quantity in the export file

diff --git a/festim/exports/derived_quantities/thermal_flux.py b/festim/exports/derived_quantities/thermal_flux.py
@@ -8,7 +8,7 @@ class ThermalFlux(SurfaceFlux):
     Args:
         surface (int): the surface id
 
-    Attribtutes
+    Attributes:
         surface (int): the surface id
         field (str): the temperature field
         title (str): the title of the derived quantity

diff --git a/festim/exports/derived_quantities/total_surface.py b/festim/exports/derived_quantities/total_surface.py
@@ -11,7 +11,7 @@ class TotalSurface(SurfaceQuantity):
         field (str, int): the field ("solute", 0, 1, "T", "retention")
         surface (int): the surface id
 
-    Attribtutes
+    Attributes:
         field (str, int): the field ("solute", 0, 1, "T", "retention")
         surface (int): the surface id
         export_unit (str): the unit of the derived quantity for exporting

diff --git a/festim/exports/derived_quantities/total_volume.py b/festim/exports/derived_quantities/total_volume.py
@@ -11,7 +11,7 @@ class TotalVolume(VolumeQuantity):
         field (str, int): the field ("solute", 0, 1, "T", "retention")
         volume (int): the volume id
 
-    Attribtutes
+    Attributes:
         field (str, int): the field ("solute", 0, 1, "T", "retention")
         volume (int): the volume id
         export_unit (str): the unit of the derived quantity for exporting