completor 0.1.3__py3-none-any.whl → 1.0.0__py3-none-any.whl

completor/exceptions/exceptions.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from completor import parse
+from completor.parse import locate_keyword
 
 
 class _BaseCaseException(Exception):
@@ -106,7 +106,7 @@ class CaseReaderFormatError(_BaseCaseException):
         super().__init__(message, lines, error_index, window_size)
 
     @staticmethod
-    def find_error_line(keyword: str, lines: list[str], header: list[str]):
+    def find_error_line(keyword: str, lines: list[str], header: list[str]) -> tuple[int, bool]:
         """Find line where error occurs.
 
         Args:
@@ -114,14 +114,14 @@ class CaseReaderFormatError(_BaseCaseException):
             lines: The (preferably) original case-file lines.
             header: The expected headers for this keyword.
 
-        Raises:
-            ValueError: If the line could not be found.
-
         Returns:
             Line number and whether there are too many/few data entries vs header.
+
+        Raises:
+            ValueError: If the line could not be found.
         """
         stripped_content = [x.strip() for x in lines]
-        start, end = parse.locate_keyword(stripped_content, keyword)
+        start, end = locate_keyword(stripped_content, keyword)
 
         line_content = {
             i + start + 1: line for i, line in enumerate(lines[start + 1 : end]) if line and not line.startswith("--")

completor/get_version.py

@@ -0,0 +1,8 @@
+"""Only used to get the version."""
+
+from importlib import metadata
+
+
+def get_version():
+    """Returns Completors version."""
+    return metadata.version("completor")

completor/hook_implementations/jobs.py

@@ -1,7 +1,6 @@
+from importlib.resources import files
 from pathlib import Path
 
-from pkg_resources import resource_filename
-
 from completor.logger import logger
 
 SKIP_TESTS = False
@@ -17,7 +16,7 @@ except ModuleNotFoundError:
 @hook_implementation
 @plugin_response(plugin_name="completor")  # type: ignore
 def installable_jobs():
-    config_file = Path(resource_filename("completor", "config_jobs/run_completor"))
+    config_file = Path(files("completor") / "config_jobs/run_completor")
     return {config_file.name: config_file}
 
 

completor/input_validation.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 import numpy as np
 import pandas as pd
 
-from completor.constants import Headers
+from completor.constants import Content, Headers
 from completor.exceptions import CompletorError
 
 
@@ -21,14 +21,22 @@ def set_default_packer_section(df_comp: pd.DataFrame) -> pd.DataFrame:
         Updated completion data for packers.
     """
     # Set default values for packer sections
-    df_comp[Headers.INNER_DIAMETER] = np.where(df_comp[Headers.ANNULUS] == "PA", 0.0, df_comp[Headers.INNER_DIAMETER])
-    df_comp[Headers.OUTER_DIAMETER] = np.where(df_comp[Headers.ANNULUS] == "PA", 0.0, df_comp[Headers.OUTER_DIAMETER])
-    df_comp[Headers.ROUGHNESS] = np.where(df_comp[Headers.ANNULUS] == "PA", 0.0, df_comp[Headers.ROUGHNESS])
+    df_comp[Headers.INNER_DIAMETER] = np.where(
+        df_comp[Headers.ANNULUS] == Content.PACKER, 0.0, df_comp[Headers.INNER_DIAMETER]
+    )
+    df_comp[Headers.OUTER_DIAMETER] = np.where(
+        df_comp[Headers.ANNULUS] == Content.PACKER, 0.0, df_comp[Headers.OUTER_DIAMETER]
+    )
+    df_comp[Headers.ROUGHNESS] = np.where(df_comp[Headers.ANNULUS] == Content.PACKER, 0.0, df_comp[Headers.ROUGHNESS])
     df_comp[Headers.VALVES_PER_JOINT] = np.where(
-        df_comp[Headers.ANNULUS] == "PA", 0.0, df_comp[Headers.VALVES_PER_JOINT]
+        df_comp[Headers.ANNULUS] == Content.PACKER, 0.0, df_comp[Headers.VALVES_PER_JOINT]
+    )
+    df_comp[Headers.DEVICE_TYPE] = np.where(
+        df_comp[Headers.ANNULUS] == Content.PACKER, Content.PERFORATED, df_comp[Headers.DEVICE_TYPE]
+    )
+    df_comp[Headers.DEVICE_NUMBER] = np.where(
+        df_comp[Headers.ANNULUS] == Content.PACKER, 0, df_comp[Headers.DEVICE_NUMBER]
     )
-    df_comp[Headers.DEVICE_TYPE] = np.where(df_comp[Headers.ANNULUS] == "PA", "PERF", df_comp[Headers.DEVICE_TYPE])
-    df_comp[Headers.DEVICE_NUMBER] = np.where(df_comp[Headers.ANNULUS] == "PA", 0, df_comp[Headers.DEVICE_NUMBER])
     return df_comp
 
 
@@ -42,9 +50,11 @@ def set_default_perf_section(df_comp: pd.DataFrame) -> pd.DataFrame:
         Updated completion data for perforated sections.
     """
     df_comp[Headers.VALVES_PER_JOINT] = np.where(
-        df_comp[Headers.DEVICE_TYPE] == "PERF", 0.0, df_comp[Headers.VALVES_PER_JOINT]
+        df_comp[Headers.DEVICE_TYPE] == Content.PERFORATED, 0.0, df_comp[Headers.VALVES_PER_JOINT]
+    )
+    df_comp[Headers.DEVICE_NUMBER] = np.where(
+        df_comp[Headers.DEVICE_TYPE] == Content.PERFORATED, 0, df_comp[Headers.DEVICE_NUMBER]
     )
-    df_comp[Headers.DEVICE_NUMBER] = np.where(df_comp[Headers.DEVICE_TYPE] == "PERF", 0, df_comp[Headers.DEVICE_NUMBER])
     return df_comp
 
 
@@ -67,10 +77,8 @@ def check_default_non_packer(df_comp: pd.DataFrame) -> pd.DataFrame:
     """
     df_comp = df_comp.copy(True)
     # set default value of roughness
-    df_comp[Headers.ROUGHNESS] = (
-        df_comp[Headers.ROUGHNESS].replace("1*", "1e-5").astype(np.float64)
-    )  # Ensures float after replacing!
-    df_nonpa = df_comp[df_comp[Headers.ANNULUS] != "PA"]
+    df_comp[Headers.ROUGHNESS] = df_comp[Headers.ROUGHNESS].replace("1*", "1e-5").astype(np.float64)
+    df_nonpa = df_comp[df_comp[Headers.ANNULUS] != Content.PACKER]
     df_columns = df_nonpa.columns.to_numpy()
     for column in df_columns:
         if "1*" in df_nonpa[column]:
@@ -136,17 +144,17 @@ def _check_for_errors(df_comp: pd.DataFrame, well_name: str, idx: int) -> None:
             If the completion description is incomplete for some range of depth.
             If the completion description is overlapping for some range of depth.
     """
-    if df_comp[Headers.ANNULUS].iloc[idx] == "PA" and (
+    if df_comp[Headers.ANNULUS].iloc[idx] == Content.PACKER and (
         df_comp[Headers.START_MEASURED_DEPTH].iloc[idx] != df_comp[Headers.END_MEASURED_DEPTH].iloc[idx]
     ):
-        raise CompletorError("Packer segments must not have length")
+        raise CompletorError("Packer segments must not have length.")
 
     if (
-        df_comp[Headers.ANNULUS].iloc[idx] != "PA"
-        and df_comp[Headers.DEVICE_TYPE].iloc[idx] != "ICV"
+        df_comp[Headers.ANNULUS].iloc[idx] != Content.PACKER
+        and df_comp[Headers.DEVICE_TYPE].iloc[idx] != Content.INFLOW_CONTROL_VALVE
         and df_comp[Headers.START_MEASURED_DEPTH].iloc[idx] == df_comp[Headers.END_MEASURED_DEPTH].iloc[idx]
     ):
-        raise CompletorError("Non packer segments must have length")
+        raise CompletorError("Non packer segments must have length.")
 
     if idx > 0:
         if df_comp[Headers.START_MEASURED_DEPTH].iloc[idx] > df_comp[Headers.END_MEASURED_DEPTH].iloc[idx - 1]:
@@ -159,22 +167,22 @@ def _check_for_errors(df_comp: pd.DataFrame, well_name: str, idx: int) -> None:
         if df_comp[Headers.START_MEASURED_DEPTH].iloc[idx] < df_comp[Headers.END_MEASURED_DEPTH].iloc[idx - 1]:
             raise CompletorError(
                 f"Overlapping completion description in well '{well_name}' from depth "
-                f"t{df_comp[Headers.END_MEASURED_DEPTH].iloc[idx - 1]} "
+                f"{df_comp[Headers.END_MEASURED_DEPTH].iloc[idx - 1]} "
                 f"to depth {(df_comp[Headers.START_MEASURED_DEPTH].iloc[idx])}"
             )
-    if df_comp[Headers.DEVICE_TYPE].iloc[idx] not in ["PERF", "AICD", "ICD", "VALVE", "DAR", "AICV", "ICV"]:
+    if df_comp[Headers.DEVICE_TYPE].iloc[idx] not in Content.DEVICE_TYPES:
         raise CompletorError(
-            f"{df_comp[Headers.DEVICE_TYPE].iloc[idx]} not a valid device type. "
+            f"{df_comp[Headers.DEVICE_TYPE].iloc[idx]} is not a valid device type. "
             "Valid types are PERF, AICD, ICD, VALVE, DAR, AICV, and ICV."
         )
-    if df_comp[Headers.ANNULUS].iloc[idx] not in ["GP", "OA", "PA"]:
+    if df_comp[Headers.ANNULUS].iloc[idx] not in Content.ANNULUS_TYPES:
         raise CompletorError(
-            f"{df_comp[Headers.ANNULUS].iloc[idx]} not a valid annulus type. Valid types are GP, OA, and PA"
+            f"{df_comp[Headers.ANNULUS].iloc[idx]} is not a valid annulus type. Valid types are GP, OA, and PA"
         )
 
 
 def set_format_wsegvalv(df_temp: pd.DataFrame) -> pd.DataFrame:
-    """Format the well segments valve (WSEGVALV) table.
+    """Format the Well Segments Valve (WELSEGS) table.
 
     Args:
         df_temp: Well segments valve data.
@@ -183,17 +191,19 @@ def set_format_wsegvalv(df_temp: pd.DataFrame) -> pd.DataFrame:
         Updated data with enforced data types and device type filled with default values.
     """
     df_temp[Headers.DEVICE_NUMBER] = df_temp[Headers.DEVICE_NUMBER].astype(np.int64)
-    df_temp[[Headers.CV, Headers.AC, Headers.AC_MAX]] = df_temp[[Headers.CV, Headers.AC, Headers.AC_MAX]].astype(
-        np.float64
+    df_temp[[Headers.FLOW_COEFFICIENT, Headers.FLOW_CROSS_SECTIONAL_AREA, Headers.MAX_FLOW_CROSS_SECTIONAL_AREA]] = (
+        df_temp[
+            [Headers.FLOW_COEFFICIENT, Headers.FLOW_CROSS_SECTIONAL_AREA, Headers.MAX_FLOW_CROSS_SECTIONAL_AREA]
+        ].astype(np.float64)
     )
-    # allows column L to have default value 1* thus it is not set to float
+    # allows column ADDITIONAL_PIPE_LENGTH_FRICTION_PRESSURE_DROP to have default value 1* thus it is not set to float
     # Create ID device column
-    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], fill_value="VALVE"))
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], fill_value=Content.VALVE))
     return df_temp
 
 
 def set_format_wsegsicd(df_temp: pd.DataFrame) -> pd.DataFrame:
-    """Format the well segments inflow control device (WSEGSICD) table.
+    """Format the well segments Inflow Control Device (ICD) table.
 
     Args:
         df_temp: Well segments inflow control device data.
@@ -209,12 +219,12 @@ def set_format_wsegsicd(df_temp: pd.DataFrame) -> pd.DataFrame:
     columns = df_temp.columns.to_numpy()[1:]
     df_temp[columns] = df_temp[columns].astype(np.float64)
     # Create ID device column
-    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], "ICD"))
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.INFLOW_CONTROL_DEVICE))
     return df_temp
 
 
 def set_format_wsegaicd(df_temp: pd.DataFrame) -> pd.DataFrame:
-    """Format the well segments automatic inflow control device (WSEGAICD) table.
+    """Format the well segments Automatic Inflow Control Device (AICD) table.
 
     Args:
         df_temp: Well segments automatic inflow control device data.
@@ -228,12 +238,12 @@ def set_format_wsegaicd(df_temp: pd.DataFrame) -> pd.DataFrame:
     columns = df_temp.columns.to_numpy()[1:]
     df_temp[columns] = df_temp[columns].astype(np.float64)
     # Create ID device column
-    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], "AICD"))
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.AUTONOMOUS_INFLOW_CONTROL_DEVICE))
     return df_temp
 
 
 def set_format_wsegdar(df_temp: pd.DataFrame) -> pd.DataFrame:
-    """Format the well segments DAR (WSEGDAR) data.
+    """Format the well segments Density Activated Recovery (DAR) data.
 
     Args:
         df_temp: Well segments DAR device data.
@@ -246,12 +256,12 @@ def set_format_wsegdar(df_temp: pd.DataFrame) -> pd.DataFrame:
     columns = df_temp.columns.to_numpy()[1:]
     df_temp[columns] = df_temp[columns].astype(np.float64)
     # Create ID device column
-    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], "DAR"))
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.DENSITY_ACTIVATED_RECOVERY))
     return df_temp
 
 
 def set_format_wsegaicv(df_temp: pd.DataFrame) -> pd.DataFrame:
-    """Format the well segments automatic inflow control valve (WSEGAICV) table.
+    """Format the well segments Automatic Inflow Control Valve (AICV) table.
 
     Args:
         df_temp: Well segments automatic inflow control valve table.
@@ -264,12 +274,12 @@ def set_format_wsegaicv(df_temp: pd.DataFrame) -> pd.DataFrame:
     columns = df_temp.columns.to_numpy()[1:]
     df_temp[columns] = df_temp[columns].astype(np.float64)
     # Create ID device column
-    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], "AICV"))
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.AUTONOMOUS_INFLOW_CONTROL_VALVE))
     return df_temp
 
 
 def set_format_wsegicv(df_temp: pd.DataFrame) -> pd.DataFrame:
-    """Format the well segments inflow control valve (WSEGICV) table.
+    """Format the well segments Inflow Control Valve (ICV) table.
 
     Args:
         df_temp: Well segments inflow control valve table.
@@ -278,12 +288,14 @@ def set_format_wsegicv(df_temp: pd.DataFrame) -> pd.DataFrame:
         Updated data.
     """
     df_temp[Headers.DEVICE_NUMBER] = df_temp[Headers.DEVICE_NUMBER].astype(np.int64)
-    df_temp[[Headers.CV, Headers.AC, Headers.AC_MAX]] = df_temp[[Headers.CV, Headers.AC, Headers.AC_MAX]].astype(
-        np.float64
+    df_temp[[Headers.FLOW_COEFFICIENT, Headers.FLOW_CROSS_SECTIONAL_AREA, Headers.MAX_FLOW_CROSS_SECTIONAL_AREA]] = (
+        df_temp[
+            [Headers.FLOW_COEFFICIENT, Headers.FLOW_CROSS_SECTIONAL_AREA, Headers.MAX_FLOW_CROSS_SECTIONAL_AREA]
+        ].astype(np.float64)
     )
     # allows column DEFAULTS to have default value 5*,  thus it is not set to float
     # Create ID device column
-    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], fill_value="ICV"))
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], fill_value=Content.INFLOW_CONTROL_VALVE))
     return df_temp
 
 
@@ -310,7 +322,7 @@ def validate_lateral_to_device(df_lat2dev: pd.DataFrame, df_comp: pd.DataFrame)
     nrow = df_lat2dev.shape[0]
     for idx in range(0, nrow):
         l2d_well = df_lat2dev[Headers.WELL].iloc[idx]
-        if (df_comp[df_comp[Headers.WELL] == l2d_well][Headers.ANNULUS] == "OA").any():
+        if (df_comp[df_comp[Headers.WELL] == l2d_well][Headers.ANNULUS] == Content.OPEN_ANNULUS).any():
             raise CompletorError(
                 f"Please do not connect a lateral to the mother bore in well {l2d_well} that has open annuli. "
                 "This may trigger an error in reservoir simulator."

completor/launch_args_parser.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import argparse
 
-import completor
+from completor.get_version import get_version
 
 COMPLETOR_DESCRIPTION = """Completor models advanced well completions for reservoir simulators.
 It generates all necessary keywords for reservoir simulation
@@ -20,22 +20,17 @@ def get_parser() -> argparse.ArgumentParser:
         argparse.ArgumentParser.
     """
     parser = argparse.ArgumentParser(description=COMPLETOR_DESCRIPTION)
-    parser.add_argument("-i", "--inputfile", required=True, type=str, help="(Compulsory) Completor case file")
-    parser.add_argument("-s", "--schedulefile", type=str, help="(Optional) if it is specified in the case file")
+    parser.add_argument("-i", "--inputfile", required=True, type=str, help="(Compulsory) Completor case file.")
+    parser.add_argument("-s", "--schedulefile", type=str, help="(Optional) if it is specified in the case file.")
     parser.add_argument(
-        "-o", "--outputfile", type=str, help="(Optional) name of output file. Defaults to <schedule>_advanced.wells"
+        "-o", "--outputfile", type=str, help="(Optional) name of output file. Defaults to <schedule>_advanced.wells."
     )
     parser.add_argument(
-        "-f", "--figure", action="store_true", help="(Optional) to generate well completion diagrams in pdf format"
+        "-f", "--figure", action="store_true", help="(Optional) to generate well completion diagrams in pdf format."
     )
     parser.add_argument(
-        "-l", "--loglevel", action="store", type=int, help="(Optional) log-level. Lower values gives more info (0-50)"
-    )
-    parser.add_argument(
-        "-v",
-        "--version",
-        action="version",
-        version="%(prog)s (completor version " + completor.__version__ + ")",
+        "-l", "--loglevel", action="store", type=int, help="(Optional) log-level. Lower values gives more info (0-50)."
     )
+    parser.add_argument("-v", "--version", action="version", version=f"Completor version {get_version()}!")
 
     return parser

completor/logger.py

@@ -7,7 +7,7 @@ import time
 from functools import wraps
 from pathlib import Path
 
-import completor
+from completor.get_version import get_version
 
 
 def get_logger(module_name="completor"):
@@ -52,7 +52,7 @@ def handle_error_messages(func):
     * The content of any files passed.
       For the main method of Completor, these are (if provided).
       * input_file.txt - The case file.
-      * schedule_file.txt  - The schedule file.
+      * schedule_file.txt - The schedule file.
       * new_file.txt - The output file.
     """
 
@@ -126,7 +126,7 @@ def dump_debug_information(**kwargs) -> None:
 
         dump("traceback.txt", traceback.format_exc())
         dump("machine.txt", socket.getfqdn())
-        dump("version.txt", completor.__version__)
+        dump("version.txt", get_version())
         dump("arguments.json", json.dumps(_convert_paths_to_strings(kwargs), indent=4))
         for key, value in kwargs.items():
             if isinstance(value, (Path, str)):