ResSimpy 2.2.2__tar.gz → 2.2.4__tar.gz

{ressimpy-2.2.2 → ressimpy-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ResSimpy
-Version: 2.2.2
+Version: 2.2.4
 Summary: A Python library for working with Reservoir Simulator Models.
 License: Apache-2.0
 Keywords: ResSimpy,Reservoir Engineering

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/DataObjectMixin.py

@@ -49,12 +49,14 @@ class DataObjectMixin(ABC):
 
     @property
     def iso_date(self) -> ISODateTime:
+        """The date of the object in ISO format."""
         if self.__iso_date is None:
             self.set_iso_date()
         return self.__iso_date
 
     @property
     def date(self) -> Optional[str]:
+        """The date of the object as written in the source file."""
         return self.__date
 
     @date.setter
@@ -64,14 +66,17 @@ class DataObjectMixin(ABC):
 
     @property
     def start_date(self) -> Optional[str]:
+        """The start date of the model (required for Nexus objects using a decimal date format)."""
         return self._start_date
 
     @property
     def date_format(self) -> Optional[DateFormat]:
+        """The date format of the date on the object."""
         return self._date_format
 
     @property
     def unit_system(self) -> Optional[UnitSystem]:
+        """The unit system being used in the object."""
         return self._unit_system
 
     def set_iso_date(self) -> None:
@@ -102,6 +107,7 @@ class DataObjectMixin(ABC):
 
     def to_table_line(self, headers: list[str]) -> str:
         """Takes a generic Nexus object and returns the attribute values as a string in the order of headers provided.
+
         Requires an implemented to_dict method and get_keyword_mapping() method.
 
         Args:

ressimpy-2.2.4/ResSimpy/FileOperations/__init__.py

@@ -0,0 +1 @@
+"""Module for file operations."""

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/FileOperations/file_operations.py

@@ -9,6 +9,7 @@ def strip_file_of_comments(file_as_list: list[str], strip_str: bool = False,
                            comment_characters: Optional[list[str]] = None,
                            square_bracket_comments: bool = False) -> list[str]:
     """Strips all of the inline, single and multi line comments out of a file.
+
     Comment characters assumed are: ! and square brackets. Escaped characters are ones wrapped in quotation marks.
 
     Args:
@@ -270,7 +271,8 @@ def __replace_with_variable_entry(new_line: str, original_line: str, replace_wit
 
 
 def check_token(token: str, line: str) -> bool:
-    """Checks if the text line contains the supplied token and is not commented out
+    """Checks if the text line contains the supplied token and is not commented out.
+
     Args:
         token (str): keyword value to search the line for
         line (str): string to search the token in

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Grid.py

@@ -1,17 +1,22 @@
+"""Grid base class."""
+
 from __future__ import annotations
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
+import os
 import pandas as pd
-from typing import Optional, Sequence, TYPE_CHECKING
-from ResSimpy.GridArrayFunction import GridArrayFunction
+import numpy as np
 
-if TYPE_CHECKING:
-    from ResSimpy.File import File
+from typing import Optional, Sequence
+from ResSimpy.GridArrayFunction import GridArrayFunction
+from ResSimpy.FileOperations import file_operations as fo
+from ResSimpy.Utils.general_utilities import check_if_string_is_float
+from ResSimpy.File import File
 
 
 @dataclass
 class GridArrayDefinition:
-    """Initialises the NexusGrid class.
+    """A class to define a grid array property.
 
     Args:
         modifier (Optional[str]): the modifier for the grid array property (e.g. CON, MULT, etc.)
@@ -26,9 +31,24 @@ class GridArrayDefinition:
     keyword_in_include_file: bool = False
     absolute_path: Optional[str] = None
 
+    def load_grid_array_definition_to_file_as_list(self) -> list[str]:
+        """Loads the grid array definition to a file as a list of strings."""
+        path = self.absolute_path
+        if path is None and self.value is not None:
+            path = self.value
+        elif path is None:
+            raise FileNotFoundError('No file path found in the grid array definition')
+        return fo.load_file_as_list(path)
+
+    def get_array(self) -> np.ndarray:
+        """Returns a 1D numpy array from the grid array definition."""
+        file_as_list = self.load_grid_array_definition_to_file_as_list()
+        return Grid.grid_file_as_list_to_numpy_array(file_as_list, None, None, None)
+
 
 @dataclass(kw_only=True)
 class Grid(ABC):
+    """A base class to represent a collection of grids in a reservoir simulation model."""
     # Grid dimensions
     _range_x: Optional[int]
     _range_y: Optional[int]
@@ -143,3 +163,64 @@ class Grid(ABC):
     def array_functions(self) -> Optional[Sequence[GridArrayFunction]]:
         """Returns a list of the array functions defined in the structured grid file."""
         raise NotImplementedError("Implement this in the derived class")
+
+    @staticmethod
+    def filter_grid_array_definition(grid_array_definition: GridArrayDefinition) -> File:
+        """Checks array files for only float values and returns a new file with only float values."""
+        file_path = grid_array_definition.absolute_path
+        if file_path is None and grid_array_definition.value is not None:
+            file_path = grid_array_definition.value
+        elif file_path is None:
+            raise FileNotFoundError('No file path found in the grid array definition')
+        file_as_list = fo.load_file_as_list(file_path)
+
+        new_file_as_list = Grid.grid_filter_file_as_list(file_as_list)
+
+        # create a new file with the filtered list
+        new_file_path = (os.path.splitext(file_path)[0] + '_filtered' +
+                         os.path.splitext(file_path)[1])
+        new_grid_file = File(location=new_file_path,
+                             file_content_as_list=new_file_as_list,
+                             create_as_modified=True,
+                             )
+
+        return new_grid_file
+
+    @staticmethod
+    def grid_filter_file_as_list(file_as_list: list[str], comment_characters: list[str] | None = None) -> list[str]:
+        """Checks array files for only float values and returns a new file with only float values.
+
+        This works for grid arrays only. It does not work well with extremely large files.
+
+        Args:
+            file_as_list (list[str]): The file as a list of strings.
+            comment_characters (Optional[list[str]]): The comment characters to filter out. Defaults to None.
+        """
+        if comment_characters is None:
+            comment_characters = ['--', '!', 'C']
+        if fo.value_in_file('INCLUDE', file_as_list):
+            raise NotImplementedError('Nested includes for grid files currently not implemented')
+        file_as_list = fo.strip_file_of_comments(file_as_list, comment_characters=comment_characters)
+        # remove non float values
+        file_as_list = [' '.join([x for x in line.split() if check_if_string_is_float(x)]) for line in file_as_list]
+        return file_as_list
+
+    @staticmethod
+    def grid_file_as_list_to_numpy_array(file_as_list: list[str], x_range: None | int, y_range: None | int,
+                                         z_range: None | int) -> np.ndarray:
+        """Converts a list of strings to a numpy array."""
+        # ensure the list of strings is filtered of comments and non-float values
+        new_file_as_list = Grid.grid_filter_file_as_list(file_as_list)
+
+        array_size = -1
+        if x_range is not None and y_range is not None and z_range is not None:
+            array_size = x_range * y_range * z_range
+
+        grid_array = np.fromstring(' '.join(new_file_as_list), sep=' ', count=array_size)
+
+        return grid_array
+
+    def grid_array_definition_to_numpy_array(self, grid_array_definition: GridArrayDefinition) -> np.ndarray:
+        """Converts a grid array to a numpy array."""
+        file_as_list = grid_array_definition.load_grid_array_definition_to_file_as_list()
+        return self.grid_file_as_list_to_numpy_array(file_as_list, self.range_x, self.range_y, self.range_z)

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/FcsFile.py

@@ -332,13 +332,15 @@ class FcsNexusFile(NexusFile):
         return_dict = dict(single_keywords, **multi_keywords)
         return return_dict
 
-    def move_model_files(self, new_file_path: str, new_include_file_location: str) -> None:
+    def move_model_files(self, new_file_path: str, new_include_file_location: str, overwrite_files: bool = False) -> \
+            None:
         """Moves all the model files to a new location.
 
         Args:
             new_file_path (str): new file path for the fcs file e.g. /new_path/new_fcs_file.fcs
             new_include_file_location (str): new location for the included files either absolute or relative
             to the new fcs file path
+            overwrite_files (bool): whether to overwrite the files if they already exist in the new location
         """
         # Take the original file, find which files have changed and write out those locations
         # figure out where to store the include files:
@@ -358,7 +360,8 @@ class FcsNexusFile(NexusFile):
                 # skip if there is no file
                 continue
             include_name = os.path.join(include_dir, os.path.basename(file.location))
-            file.write_to_file(include_name, write_includes=True, write_out_all_files=True)
+            file.write_to_file(include_name, write_includes=True, write_out_all_files=True,
+                               overwrite_file=overwrite_files)
             self.change_file_path(include_name, keyword)
 
         for keyword, attr_name in self.fcs_keyword_map_multi().items():
@@ -367,11 +370,12 @@ class FcsNexusFile(NexusFile):
                 continue
             for method_number, file in file_dict.items():
                 include_name = os.path.join(include_dir, os.path.basename(file.location))
-                file.write_to_file(include_name, write_includes=True, write_out_all_files=True)
+                file.write_to_file(include_name, write_includes=True, write_out_all_files=True,
+                                   overwrite_file=overwrite_files)
                 self.change_file_path(include_name, keyword, method_number)
 
         # write out the final fcs file
-        self.write_to_file(new_file_path, write_includes=False)
+        self.write_to_file(new_file_path, write_includes=False, overwrite_file=overwrite_files)
 
     def write_out_case(self, new_file_path: str, new_include_file_location: str, case_suffix: str) -> None:
         """Writes out a new simulator with only modified files. For use with creating multiple cases from a base case.
@@ -425,6 +429,7 @@ class FcsNexusFile(NexusFile):
 
     def update_model_files(self) -> None:
         """Updates all the modified files in the model. Keeps file names and paths the same.
+
         Warning: this method overwrites the existing files!
         """
         # Loop through all files in the model, writing out the contents if they have been modified.

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusConstraint.py

@@ -12,7 +12,9 @@ from ResSimpy.Nexus.NexusEnums.DateFormatEnum import DateFormat
 
 @dataclass(repr=False)
 class NexusConstraint(Constraint):
-    """Attributes:
+    """Class representing a single constraint object within the NexusNetwork for a single datetime.
+
+    Attributes:
     name (str): name of the well (NAME)
     max_surface_oil_rate (float): max surface oil rate (QOSMAX)
     max_surface_gas_rate (float): max surface gas rate (QGSMAX)
@@ -420,6 +422,7 @@ class NexusConstraint(Constraint):
 
     def write_qmult_table(self) -> list[str]:
         """Writes out a QMULT table from a constraint that uses the following attributes.
+
         'QOIL': ('qmult_oil_rate', float).
         'QWATER': ('qmult_water_rate', float).
         'QGAS': ('qmult_gas_rate', float).

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusConstraints.py

@@ -1,6 +1,8 @@
-"""Class that holds all the constraints for a NexusNetwork object. This class is responsible for loading,
-modifying and removing constraints from the NexusNetwork object. This class is also responsible for
-writing the constraints to the Nexus deck. An instance of this is held within the Network class as "constraints".
+"""Class that holds all the constraints for a NexusNetwork object.
+
+This class is responsible for loading, modifying and removing constraints from the NexusNetwork object. This class is
+also responsible for writing the constraints to the Nexus deck. An instance of this is held within the Network class
+as "constraints".
 """
 from __future__ import annotations
 
@@ -26,9 +28,10 @@ if TYPE_CHECKING:
 
 @dataclass
 class NexusConstraints(Constraints):
-    """Class that holds all the constraints for a NexusNetwork object. This class is responsible for loading,
-    modifying and removing constraints from the NexusNetwork object. This class is also responsible for
-    writing the constraints to the Nexus deck.
+    """Class that holds all the constraints for a NexusNetwork object.
+
+    This class is responsible for loading, modifying and removing constraints from the NexusNetwork object. This
+    class is also responsible for writing the constraints to the Nexus deck.
 
     Attributes:
         constraints: dict[str, list[NexusConstraint]]: dictionary of all constraints defined within a model,
@@ -49,7 +52,8 @@ class NexusConstraints(Constraints):
 
     def get_all(self, object_name: Optional[str] = None, date: Optional[str] = None) -> \
             dict[str, list[NexusConstraint]]:
-        """Get the constraints of the existing model with optional parameters to filter for name and date
+        """Get the constraints of the existing model with optional parameters to filter for name and date.
+
         Args:
             object_name (Optional[str]): name of the connection, node or wellname to return. Defaults to None.
             date (Optional[str]): date in model format to filter the dates to in the constraints
@@ -74,7 +78,8 @@ class NexusConstraints(Constraints):
         return date_filtered_constraints
 
     def get_df(self) -> pd.DataFrame:
-        """Creates a dataframe representing all processed constraint data in a surface file
+        """Creates a dataframe representing all processed constraint data in a surface file.
+
         Returns:
             DataFrame: of the properties of the constraint through time with each row representing \
                 a change in constraint.
@@ -106,6 +111,7 @@ class NexusConstraints(Constraints):
 
     def _add_to_memory(self, additional_constraints: Optional[dict[str, list[NexusConstraint]]]) -> None:
         """Adds additional constraints to memory within the NexusConstraints object.
+
             If user adds constraints list this will not be reflected in the Nexus deck at this time.
 
         Args:
@@ -145,7 +151,8 @@ class NexusConstraints(Constraints):
 
     def remove(self, constraint_dict: Optional[dict[str, None | float | str | int]] = None,
                constraint_id: Optional[UUID] = None) -> None:
-        """Remove a constraint based on closest matching constraint, requires node name and date.\
+        """Remove a constraint based on closest matching constraint, requires node name and date.
+
         Needs one of at least constraint dict or constraint id.
 
         Args:
@@ -382,8 +389,9 @@ class NexusConstraints(Constraints):
                new_constraint_props: dict[str, None | float | int | str | UnitSystem] | Constraint,
                comments: Optional[str] = None) \
             -> None:
-        """Modify an existing constraint. Retains existing constraint values that are not overridden by the new \
-        constraint properties.
+        """Modify an existing constraint.
+
+        Retains existing constraint values that are not overridden by the new constraint properties.
 
         Args:
             name (str): The well name

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusNodeConnections.py

@@ -1,4 +1,6 @@
-"""Holds all the node connections in a network. This class is responsible for loading, modifying and removing
+"""Holds all the node connections in a network.
+
+This class is responsible for loading, modifying and removing
 connections from a network. It also holds the list of connections in memory.
 An instance is held within the NexusNetwork class as "connections".
 """
@@ -27,8 +29,10 @@ if TYPE_CHECKING:
 
 @dataclass(kw_only=True)
 class NexusNodeConnections(NodeConnections):
-    """Holds all the node connections in a network. This class is responsible for loading, modifying and removing
-    connections from a network. It also holds the list of connections in memory.
+    """Holds all the node connections in a network.
+
+    This class is responsible for loading, modifying and removing connections from a network. It also holds the list
+    of connections in memory.
     """
     __connections: list[NexusNodeConnection] = field(default_factory=list)
 
@@ -67,7 +71,8 @@ class NexusNodeConnections(NodeConnections):
         return next(connections_to_return, None)
 
     def get_df(self) -> pd.DataFrame:
-        """Creates a dataframe representing all processed node connection data in a surface file
+        """Creates a dataframe representing all processed node connection data in a surface file.
+
         Returns:
             DataFrame: of the properties of the connections through time with each row representing a node.
         """
@@ -123,7 +128,8 @@ class NexusNodeConnections(NodeConnections):
     def modify(self, obj_to_modify: dict[str, None | str | float | int],
                new_properties: dict[str, None | str | float | int]) -> None:
         """Modifies an existing connection based on a matching dictionary of properties.
-        (partial matches allowed if precisely 1 matching node is found).
+
+        Partial matches allowed if precisely 1 matching node is found.
         Updates the properties with properties in the new_properties dictionary.
 
         Args:

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusNodes.py

@@ -1,4 +1,5 @@
 """Holds the NexusNodes class which is used to store and manipulate the nodes in a NexusNetwork.
+
 It is stored as an instance in the NexusNetwork class as "nodes".
 """
 
@@ -26,6 +27,7 @@ if TYPE_CHECKING:
 @dataclass(kw_only=True)
 class NexusNodes(Nodes):
     """Class to store and manipulate the nodes in a NexusNetwork.
+
     It is stored as an instance in the NexusNetwork class as "nodes". A list of nodes in the network are stored in
     memory these can be accessed through the get_all method.
     """
@@ -77,7 +79,8 @@ class NexusNodes(Nodes):
         return next(nodes_to_return, None)
 
     def get_df(self) -> pd.DataFrame:
-        """Creates a dataframe representing all processed node data in a surface file
+        """Creates a dataframe representing all processed node data in a surface file.
+
         Returns:
             DataFrame: of the properties of the nodes through time with each row representing a node.
         """
@@ -144,8 +147,10 @@ class NexusNodes(Nodes):
 
     def modify(self, node_to_modify: dict[str, None | str | float | int],
                new_properties: dict[str, None | str | float | int]) -> None:
-        """Modifies an existing node based on a matching dictionary of properties (partial matches allowed if precisely
-         1 matching node is found). Updates the properties with properties in the new_properties dictionary.
+        """Modifies an existing node based on a matching dictionary of properties.
+
+        Partial matches allowed if precisely 1 matching node is found. Updates the properties with properties in the
+        new_properties dictionary.
 
         Args:
             node_to_modify (dict[str, None | str | float | int]): dictionary containing attributes to match in the

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusProc.py

@@ -86,9 +86,9 @@ class NexusProc:
 
     @staticmethod
     def reset_nexus_proc_function_counts() -> dict[str, int]:
-        """This function initializes and returns a dict of built-in Nexus proc functions. Please refer to page
-        1013 of the 2022 Nexus Keyword manual for a description of the functions.
+        """This function initializes and returns a dict of built-in Nexus proc functions.
 
+        Please refer to page 1013 of the 2022 Nexus Keyword manual for a description of the functions.
             Returns: A dictionary of Nexus proc functions where the key is the specific function and the value is
         the count, initialized to zero.
         """

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusProcs.py

@@ -11,8 +11,9 @@ if TYPE_CHECKING:
 
 @dataclass(kw_only=True)
 class NexusProcs:
-    """Class for handling procedures in the Nexus Network. This class is used to store and collect information about
-    certain procedures written in the Nexus surface file.
+    """Class for handling procedures in the Nexus Network.
+
+    This class is used to store and collect information about certain procedures written in the Nexus surface file.
     """
     # need field function to make a new unique empty list
     __procs: list[NexusProc] = field(default_factory=list)

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusTargets.py

@@ -1,5 +1,7 @@
-"""Class for handling targets in the Nexus Network. This class is used to store and manipulate the targets in a
-NexusNetwork. It is stored as an instance in the NexusNetwork class as "targets".
+"""Class for handling targets in the Nexus Network.
+
+This class is used to store and manipulate the targets in a NexusNetwork. It is stored as an instance in the
+NexusNetwork class as "targets".
 """
 from __future__ import annotations
 from dataclasses import dataclass, field
@@ -24,8 +26,10 @@ if TYPE_CHECKING:
 
 @dataclass(kw_only=True)
 class NexusTargets(Targets):
-    """Class for handling targets in the Nexus Network. This class is used to store and manipulate the targets in a
-    NexusNetwork. It is stored as an instance in the NexusNetwork class as "targets".
+    """Class for handling targets in the Nexus Network.
+
+    This class is used to store and manipulate the targets in a NexusNetwork. It is stored as an instance in the
+    NexusNetwork class as "targets".
     """
     __targets: list[NexusTarget] = field(default_factory=list)
 
@@ -75,7 +79,8 @@ class NexusTargets(Targets):
         return next(targets_to_return, None)
 
     def get_df(self) -> pd.DataFrame:
-        """Creates a dataframe representing all processed target data in a surface file
+        """Creates a dataframe representing all processed target data in a surface file.
+
         Returns:
             DataFrame: of the properties of the targets through time with each row representing a target.
         """
@@ -142,8 +147,10 @@ class NexusTargets(Targets):
 
     def modify(self, target_to_modify: dict[str, None | str | float | int],
                new_properties: dict[str, None | str | float | int]) -> None:
-        """Modifies an existing node based on a matching dictionary of properties (partial matches allowed if precisely
-         1 matching node is found). Updates the properties with properties in the new_properties dictionary.
+        """Modifies an existing node based on a matching dictionary of properties.
+
+        Partial matches allowed if precisely 1 matching node is found. Updates the properties with properties in the
+        new_properties dictionary.
 
         Args:
             target_to_modify (dict[str, None | str | float | int]): dictionary containing attributes to match in the

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusWellConnections.py

@@ -1,4 +1,6 @@
-"""Class for handling well connections in the Nexus Network. This class is used to store and manipulate the well
+"""Class for handling well connections in the Nexus Network.
+
+This class is used to store and manipulate the well
 connections in a NexusNetwork. It is stored as an instance in the NexusNetwork class as "well_connections".
 In Nexus this is the WELLS table.
 """
@@ -25,10 +27,11 @@ if TYPE_CHECKING:
 
 @dataclass
 class NexusWellConnections(WellConnections):
-    """Class for handling well connections in the Nexus Network. This class is used to store and manipulate the well
-    connections in a NexusNetwork. It is stored as an instance in the NexusNetwork class as "well_connections".
-    In Nexus this is the WELLS table. The list of well connections can be accessed in the NexusNetwork class through the
-    get_all method.
+    """Class for handling well connections in the Nexus Network.
+
+    This class is used to store and manipulate the well connections in a NexusNetwork. It is stored as an instance in
+    the NexusNetwork class as "well_connections". In Nexus this is the WELLS table. The list of well connections can
+    be accessed in the NexusNetwork class through the get_all method.
     """
     _well_connections: list[NexusWellConnection] = field(default_factory=list)
 
@@ -67,7 +70,8 @@ class NexusWellConnections(WellConnections):
         return next(to_return, None)
 
     def get_df(self) -> pd.DataFrame:
-        """Creates a dataframe representing all processed well connections data in a surface file
+        """Creates a dataframe representing all processed well connections data in a surface file.
+
         Returns:
             DataFrame: of the properties of the well connections through time with each row representing a single well \
             connection.
@@ -115,7 +119,8 @@ class NexusWellConnections(WellConnections):
     def modify(self, obj_to_modify: dict[str, None | str | float | int],
                new_properties: dict[str, None | str | float | int]) -> None:
         """Modifies an existing well connection based on a matching dictionary of properties.
-        (partial matches allowed if precisely 1 matching node is found).
+
+        Partial matches allowed if precisely 1 matching node is found.
         Updates the properties with properties in the new_properties dictionary.
 
         Args:

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusWellbores.py

@@ -1,5 +1,7 @@
-"""Class for handling wellbores in the Nexus Network. This class is used to store and manipulate the wellbores in a
-NexusNetwork. It is stored as an instance in the NexusNetwork class as "wellbores".
+"""Class for handling wellbores in the Nexus Network.
+
+This class is used to store and manipulate the wellbores in a NexusNetwork. It is stored as an instance in the
+NexusNetwork class as "wellbores".
 """
 from __future__ import annotations
 
@@ -25,9 +27,11 @@ if TYPE_CHECKING:
 
 @dataclass
 class NexusWellbores(Wellbores):
-    """Class for handling wellbores in the Nexus Network. This class is used to store and manipulate the wellbores in a
-    NexusNetwork. It is stored as an instance in the NexusNetwork class as "wellbores". The list of wellbores can be
-    accessed in the NexusNetwork class through the get_all method.
+    """Class for handling wellbores in the Nexus Network.
+
+    This class is used to store and manipulate the wellbores in a NexusNetwork. It is stored as an instance in the
+    NexusNetwork class as "wellbores". The list of wellbores can be accessed in the NexusNetwork class through the
+    get_all method.
     """
     __wellbores: list[NexusWellbore] = field(default_factory=list)
 
@@ -113,7 +117,8 @@ class NexusWellbores(Wellbores):
     def modify(self, obj_to_modify: dict[str, None | str | float | int],
                new_properties: dict[str, None | str | float | int]) -> None:
         """Modifies an existing wellbore based on a matching dictionary of properties.
-        (partial matches allowed if precisely 1 matching node is found).
+
+        Partial matches allowed if precisely 1 matching node is found.
         Updates the properties with properties in the new_properties dictionary.
 
         Args:

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/Network/NexusWellheads.py

@@ -1,6 +1,7 @@
-"""Class for handling wellheads in the Nexus Network. This class is used to store and manipulate the wellheads in \
-a NexusNetwork. It is stored as an instance in the NexusNetwork class as "wellheads".
-In Nexus this is the WELLHEAD table.
+"""Class for handling wellheads in the Nexus Network.
+
+This class is used to store and manipulate the wellheads in a NexusNetwork. It is stored as an instance in the
+NexusNetwork class as "wellheads". In Nexus this is the WELLHEAD table.
 """
 from __future__ import annotations
 from dataclasses import dataclass, field
@@ -107,7 +108,8 @@ class NexusWellheads(Wellheads):
     def modify(self, obj_to_modify: dict[str, None | str | float | int],
                new_properties: dict[str, None | str | float | int]) -> None:
         """Modifies an existing wellhead based on a matching dictionary of properties.
-        (partial matches allowed if precisely 1 matching node is found).
+
+        Partial matches allowed if precisely 1 matching node is found.
         Updates the properties with properties in the new_properties dictionary.
 
         Args:

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/NexusFile.py

@@ -402,8 +402,9 @@ class NexusFile(File):
         return from_list, to_list
 
     def add_object_locations(self, obj_uuid: UUID, line_indices: list[int]) -> None:
-        """Adds a uuid to the object_locations dictionary. Used for storing the line numbers where objects are stored
-        within the flattened file_as_list.
+        """Adds a uuid to the object_locations dictionary.
+
+        Used for storing the line numbers where objects are stored within the flattened file_as_list.
 
         Args:
             obj_uuid (UUID): unique identifier of the object being created/stored.
@@ -420,9 +421,10 @@ class NexusFile(File):
             self.object_locations[obj_uuid] = line_indices
 
     def __update_object_locations(self, line_number: int, number_additional_lines: int) -> None:
-        """Updates the object locations in a nexusfile by the additional lines. Used when files have been modified and
-        an addition/removal of lines has occurred. Ensures that the object locations are correct to the actual lines
-        in the file_as_list.
+        """Updates the object locations in a nexusfile by the additional lines.
+
+        Used when files have been modified and an addition/removal of lines has occurred. Ensures that the object
+        locations are correct to the actual lines in the file_as_list.
 
         Args:
             line_number (int): Line number at which the new lines have been added
@@ -449,7 +451,7 @@ class NexusFile(File):
         self.object_locations.pop(obj_uuid, None)
 
     def find_which_include_file(self, flattened_index: int) -> tuple[File, int]:
-        """Given a line index that relates to a position within the flattened file_as_list from the method
+        """Given a line index that relates to a position within the flattened file_as_list from the method \
         get_flat_file_as_list.
 
         Args:
@@ -577,8 +579,9 @@ class NexusFile(File):
 
     def remove_from_file_as_list(self, index: int, objects_to_remove: Optional[list[UUID]] = None,
                                  string_to_remove: Optional[str] = None) -> None:
-        """Remove an entry from the file as list. Also updates existing object locations and removes any \
-        specified objects from the object locations dictionary.
+        """Remove an entry from the file as list.
+
+        Also updates existing object locations and removes any specified objects from the object locations dictionary.
 
         Args:
             index (int): index n the calling flat_file_as_list to remove the entry from

{ressimpy-2.2.2 → ressimpy-2.2.4}/ResSimpy/Nexus/DataModels/NexusPVTMethod.py

@@ -222,6 +222,7 @@ class NexusPVTMethod(DynamicProperty):
     def __populate_eos_opts_to_tertiary_keys(self, primary_key: str, primary_key_default_val: str, single_line: str,
                                              line_list: list[str], list_of_secondary_keys: list[str]) -> None:
         """Utility function to populate complex EOS options structures, from primary to tertiary keyword level.
+
         Applies to TRANSITION, TRANS_TEST and PHASEID Nexus EOS options.
 
         Args: