wolfhece 2.1.67__py3-none-any.whl → 2.1.69__py3-none-any.whl

wolfhece/Model1D.py

@@ -131,9 +131,9 @@ class Creator_1D:
     This object contains the methods operations
     performed in the creation of 1D models.
     They consist of the following operations:
-     - Concatenation of information in 1 and 2 dimensions,
-     - Extraction of information from 2D data if provided,
-     - Creation of a 1D model (simulation).
+        - Concatenation of information in 1 and 2 dimensions,
+        - Extraction of information from 2D data if provided,
+        - Creation of a 1D model (simulation).
 
     .. todo:: 1) FIXME Create unittests for methods in this class,
     .. todo:: 2) FIXME Fasten the methods in this class using multiprocess.
@@ -168,9 +168,11 @@ class Creator_1D:
         :type zones2: Zones
         :param id1:  Position in `.myzones` of the zone
         containing the vectors, defaults to 0
+
         :type id1: int, optional
         :param id2: Position in `.myzones` of the zone
         containing the vectors, defaults to 0
+
         :type id2: int, optional
         :return: The 2 zones with the aligned vertices.
         :rtype: Zones
@@ -220,16 +222,20 @@ class Creator_1D:
         :type zones2: Zones
         :param id1: Position in `.myzones` of the zone
         containing the vectors, defaults to 0
+
         :type id1: int, optional
         :param id2: Position in `.myzones` of the zone
         containing the vectors, defaults to 0
+
         :type id2: int, optional
         :param buffer: number of vertices to process on each vector
         starting from the end of the vector (None means all vertices are processed),
         defaults to None
+
         :type buffer: int, optional
         :return: The vectors with the deleted overlaps.
         :rtype: Zones
+
         .. todo:: 1) FIXME Generalize the method to work with any number of vectors.
         .. todo:: 2) FIXME iS there a way to perform this operation geometrically with shapely line string?
         .. todo:: 3) FIXME Create unittests for this method.
@@ -416,6 +422,7 @@ class Creator_1D:
         this is the number of vertices to process on each vector
         starting from the end of the vector
         (None means all vertices are processed),defaults to None, defaults to None
+
         :type buffer: int, defaults to None
         :param save_as: File path of the new vector, defaults to None
         :type save_as: str, optional
@@ -466,6 +473,7 @@ class Creator_1D:
         :type buffer: While deleting overlaps, this is the number of vertices
         to process on each vector starting from the end of the vector
         (None means all vertices are processed),defaults to None
+
         :param save_as: _description_, defaults to None
         :type save_as: File path of the new vector, optional
         :raises Exception: With a GUI, to warn the user that the list of zones is missing.
@@ -554,7 +562,7 @@ class Creator_1D:
         contained in those vectors to a new zone that will be returned.
         FIXME: Remove Id from all methods and delete the parameter from the method signature.
 
-        :param zones_list:List of vectors (`Zones`).
+        :param zones_list: List of vectors (`Zones`).
         :type zones_list: list[Zones]
         :param id: Depreciated, defaults to 1
         :type id: int, optional
@@ -750,6 +758,7 @@ class Creator_1D:
         :type save_as: str, optional
         :return: The new Zones containing the supports.
         :rtype: Zones
+
         .. todo:: 1) FIXME create a test for this method
         .. todo:: 2) FIXME Think about a faster way to create the supports
         .. todo:: 3) FIXME could it replace the current method for the cration of bed in wolfpy?
@@ -882,9 +891,11 @@ class Creator_1D:
         :type zones: Zones
         :param filename: .csv file containing the sections and their minimum altitudes,
         first column is the section name and second column is the minimum altitude.
+
         :type filename: str
         :param save_as: path to the the file where the modified Zones will be saved
         if no path is given the results is not saved but only returned , defaults to ''
+
         :type save_as: str, optional
         :return: New Zones object with the modified altitudes
         :rtype: Zones
@@ -921,9 +932,11 @@ class Creator_1D:
         :type zones: Zones
         :param filename: .csv file containing the sections and their minimum altitudes,
         first column is the section name and second column is the minimum altitude.
+
         :type filename: str
         :param save_as: path to the the file where the modified Zones will be saved
         if no path is given the results is not saved but only returned , defaults to ''
+
         :type save_as: str, optional
         :return: New Zones object with the modified altitudes
         :rtype: Zones
@@ -961,9 +974,11 @@ class Creator_1D:
         :type zones: Zones
         :param filename: .csv file containing the sections and their minimum altitudes,
         first column is the section name and second column is the minimum altitude.
+
         :type filename: str
         :param save_as: path to the the file where the modified Zones will be saved
         if no path is given the results is not saved but only returned , defaults to ''
+
         :type save_as: str, optional
         :return: New Zones object with the modified altitudes
         :rtype: Zones
@@ -1003,6 +1018,7 @@ class Creator_1D:
         :type zones: Zones
         :param save_as: path to the the file where the modified Zones will be saved
         if no path is given the results is not saved but only returned , defaults to ''
+
         :type save_as: str, optional
         :return: New Zones object with the reversed vectors
         :rtype: Zones
@@ -1223,6 +1239,7 @@ class Creator_1D:
         :type zones_list: list[Zones]
         :param id: Index of the zone containing the vector object
         in all `Zones`, defaults to 0
+
         :type id: int, optional
 
         .. todo:: 1) FIXME Add detailed information (legends, title, an so on) to the plot.
@@ -1300,15 +1317,12 @@ class Creator_1D:
             - Id : zone index
             - The discretization step is chosen by the user.
 
-        .. notes:: The procedure is the following:
-        From the 3 vectors of the zone, the center vector is discretized
-        based on the discretization step provided by the user (1 length unit by default).
-        The number of points is calculated as the length of the center vector divided by the discretization step.
-        the number of points selected is the smallest integer greater than the division result.
-        The newpoints  are then projected on the left and right vectors.
-        The distance between the left and right vectors is then calculated,
-        and plotted as a function of the distance along the center vector, after a postprocessing check using
-        subtrings and vectors.
+        .. note:: The procedure is the following:
+                - From the 3 vectors of the zone, the center vector is discretized based on the discretization step provided by the user (1 length unit by default).
+                - The number of points is calculated as the length of the center vector divided by the discretization step.
+                - The number of points selected is the smallest integer greater than the division result.
+                - The newpoints  are then projected on the left and right vectors.
+                - The distance between the left and right vectors is then calculated, and plotted as a function of the distance along the center vector, after a postprocessing check using subtrings and vectors.
 
         :param zones: `Zones` object containing the vectors,
         :type zones: Zones
@@ -1316,12 +1330,13 @@ class Creator_1D:
         :type id: int, optional
         :param discretization: After how many unit a disctance should be sampled, defaults to 1
         :type discretization: float, optional
-        :param Figure_title:Title to be displayed on the figure, defaults to ''
+        :param Figure_title: Title to be displayed on the figure, defaults to ''
         :type Figure_title: str, optional
         :param ticks_spacing: Discretization of the x axis, defaults to 1000
         :type ticks_spacing: int, optional
 
-        .. notes:: FIXME Should be an option in GUI and check whether the substring step is necessary.
+        .. note:: FIXME Should be an option in GUI and check whether the substring step is necessary.
+
         .. todo:: 1) FIXME Add detailed information (legends, title, an so on) to the plot.
         .. todo:: 2) FIXME Think about a test for this method. could it be used in GUI?
         """
@@ -1657,6 +1672,7 @@ class Creator_1D:
         :param file_out: File path of the new WolfArray, file_out is provided ('' by default)
         a folder of the mask (given array) is used  to store the output under the same name
         as the previous but with a prefix `new_` added, defaults to ''
+
         :type file_out: str, optional
         :param load: If the new WolfArray should be loaded or not, defaults to True
         :type load: bool, optional
@@ -1714,6 +1730,7 @@ class Creator_1D:
         :type vrt_file: str
         :param wolfarray_not_tif: If the new WolfArrays should be saved as a `.bin` file or `.tif` file,
         defaults to True
+
         :type wolfarray_not_tif: bool, optional
         :return: List of new WolfArrays
         :rtype: list[WolfArray]
@@ -2417,6 +2434,7 @@ class Creator_1D:
         :type mycross: crosssections
         :param vect: `vector` containing the profiles
         in case the profiles should be sorted, defaults to None
+
         :type vect: vector, optional
         :param profile_name: Index of the profile, defaults to 1
         :type profile_name: int, optional
@@ -3065,7 +3083,7 @@ class Creator_1D:
         :param directory: Directory path, defaults to ''
         :type directory: str, optional
 
-        .. notes:: FIXME delete from_steady  arguments wherever it's still implemented in this module.
+        .. note:: FIXME delete from_steady  arguments wherever it's still implemented in this module.
         """
 
         if directory == '':
@@ -5405,6 +5423,7 @@ class Creator_1D:
         :type directory: str
         :param plot: wheter the process should open a matplotlib figure
         containing the steady state solution or not, defaults to True
+
         :type plot: bool, optional
         """
         self.write_parameters(directory, write_type= 2, max_time=0)