TNO Intern

Commit 4d43a46a authored by Hen Brett's avatar Hen Brett 🐔
Browse files

Adding information on the mask_value to the docstring

parent 24568209

src/pythermogis/doublet_simulation/deterministic_doublet.py

+2 −2
Original line number Diff line number Diff line
@@ -51,10 +51,10 @@ def calculate_doublet_performance(reservoir_properties: xr.Dataset, utc_properti 
        False by default, If set to True print the time in seconds it took to simulate across all reservoir properties



    mask_value : float

        Any cell that results in:

        0.0 by default, Any cell that results in:

        1. a failed simulation

        2. failed input validation checks

        will be assigned the mask_value, by default it is 0

        will be assigned the mask_value



    Returns

    -------

src/pythermogis/doublet_simulation/stochastic_doublet.py

+7 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ def calculate_doublet_performance_stochastic( 
        p_values: List[float] = [50.0],

        chunk_size: int = None,

        print_execution_duration = False,

        mask_value: float = np.nan

        mask_value: float = 0.0,

) -> xr.Dataset:

    """

    Perform a ThermoGIS Stochastic Doublet performance simulation.
@@ -65,6 +65,12 @@ def calculate_doublet_performance_stochastic( 
    print_execution_duration : bool

        False by default, If set to True print the time in seconds it took to simulate across all reservoir properties



    mask_value : float

        0.0 by default, Any cell that results in:

        1. a failed simulation

        2. failed input validation checks

        will be assigned the mask_value



    Returns

    -------

    output_data : xr.Dataset

src/pythermogis/thermogis_classes/doublet.py

+6 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ def simulate_doublet( 
    reservoir_properties: xr.Dataset,

    rng_seed: int,

    utc_properties: JClass,

    mask_value: float = np.nan

    mask_value: float = 0.0

) -> xr.Dataset:

    # Calculate transmissivity scaled by ntg and converted to Dm

    output_data[f"transmissivity_with_ntg"] = (output_data[f"transmissivity"] *
@@ -76,6 +76,11 @@ def calculate_performance_of_single_location(mask: float, depth: float, thicknes 
        Product of transmissivity and net-to-gross.

    doublet : object

        An instance of the ThermoGIS doublet class.

    mask_value : float

        0.0 by default, Any cell that results in:

        1. a failed simulation

        2. failed input validation checks

        will be assigned the mask_value



    Returns

    -------