TNO Intern

Commit 437cf52c authored by Hen Brett's avatar Hen Brett 🐔
Browse files

improving the docstrings

parent c35eb084
Loading
Loading
Loading
Loading
Loading
+2 −15
Original line number Diff line number Diff line
@@ -258,7 +258,6 @@ environments:
      - pypi: https://files.pythonhosted.org/packages/bd/24/12818598c362d7f300f18e74db45963dbcb85150324092410c8b49405e42/pyproject_hooks-1.2.0-py3-none-any.whl
      - pypi: https://files.pythonhosted.org/packages/05/19/94d6c66184c7d0f9374330c714f62c147dbb53eda9efdcc8fc6e2ac454c5/rasterio-1.4.3-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
      - pypi: https://files.pythonhosted.org/packages/2a/2f/63d2cacc0e525f8e3398bcf32bd3620385f22cd1600834ec49d7f3597a7b/rioxarray-0.19.0-py3-none-any.whl
      - pypi: https://files.pythonhosted.org/packages/a8/a6/7985ad1778e60922d4bef546688cd8a25822c58873e9ff30189cfe5dc4ab/ruff-0.13.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
      - pypi: https://files.pythonhosted.org/packages/b5/09/c5b6734a50ad4882432b6bb7c02baf757f5b2f256041da5df242e2d7e6b6/scipy-1.15.3-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
      - pypi: https://files.pythonhosted.org/packages/d1/a7/5c9cb413e4e2ce52c16be717e94abd40ce91b1f8974624d5d56154c5d40b/shapely-2.1.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
      - pypi: ./
@@ -490,7 +489,6 @@ environments:
      - pypi: https://files.pythonhosted.org/packages/bd/24/12818598c362d7f300f18e74db45963dbcb85150324092410c8b49405e42/pyproject_hooks-1.2.0-py3-none-any.whl
      - pypi: https://files.pythonhosted.org/packages/df/88/9db5f49ebfdd9c12365e4cac76c34ccb1a642b1c8cbab4124b3c681495de/rasterio-1.4.3-cp313-cp313-win_amd64.whl
      - pypi: https://files.pythonhosted.org/packages/2a/2f/63d2cacc0e525f8e3398bcf32bd3620385f22cd1600834ec49d7f3597a7b/rioxarray-0.19.0-py3-none-any.whl
      - pypi: https://files.pythonhosted.org/packages/61/21/0647eb71ed99b888ad50e44d8ec65d7148babc0e242d531a499a0bbcda5f/ruff-0.13.0-py3-none-win_amd64.whl
      - pypi: https://files.pythonhosted.org/packages/87/2e/892ad2862ba54f084ffe8cc4a22667eaf9c2bcec6d2bff1d15713c6c0703/scipy-1.15.3-cp313-cp313-win_amd64.whl
      - pypi: https://files.pythonhosted.org/packages/e3/f0/9f8cdf2258d7aed742459cea51c70d184de92f5d2d6f5f7f1ded90a18c31/shapely-2.1.0-cp313-cp313-win_amd64.whl
      - pypi: ./
@@ -4829,8 +4827,8 @@ packages:
  timestamp: 1740946648058
- pypi: ./
  name: pythermogis
  version: 1.1.0
  sha256: 6b65f4805e94338a6160a1fa39a124410ee9af997fdbca4ab3cbefb643beb922
  version: 1.1.1
  sha256: 6144a7e98f661d174d6aeae7b3695e7d78fa2ad50a26133e22e6c0239ec33186
  requires_dist:
  - jpype1>=1.5.2,<2
  - xarray==2024.9.0.*
@@ -4838,7 +4836,6 @@ packages:
  - pytz>=2024.1,<2025
  - build>=1.2.2.post1,<2
  - pygridsio>=0.3.27,<0.4
  - ruff>=0.13.0,<0.14
  requires_python: '>=3.11'
  editable: true
- conda: https://conda.anaconda.org/conda-forge/linux-64/python-3.13.3-hf636f53_101_cp313.conda
@@ -5204,16 +5201,6 @@ packages:
  - scipy ; extra == 'interp'
  - scipy ; extra == 'all'
  requires_python: '>=3.10'
- pypi: https://files.pythonhosted.org/packages/61/21/0647eb71ed99b888ad50e44d8ec65d7148babc0e242d531a499a0bbcda5f/ruff-0.13.0-py3-none-win_amd64.whl
  name: ruff
  version: 0.13.0
  sha256: 48e5c25c7a3713eea9ce755995767f4dcd1b0b9599b638b12946e892123d1efb
  requires_python: '>=3.7'
- pypi: https://files.pythonhosted.org/packages/a8/a6/7985ad1778e60922d4bef546688cd8a25822c58873e9ff30189cfe5dc4ab/ruff-0.13.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  name: ruff
  version: 0.13.0
  sha256: 03447f3d18479df3d24917a92d768a89f873a7181a064858ea90a804a7538991
  requires_python: '>=3.7'
- conda: https://conda.anaconda.org/conda-forge/linux-64/s2n-1.5.21-h7ab7c64_0.conda
  sha256: c8b252398b502a5cc6ea506fd2fafe7e102e7c9e2ef48b7813566e8a72ce2205
  md5: 28b5a7895024a754249b2ad7de372faa
+4 −2
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "pythermogis"
version = "1.1.0"
version = "1.1.1"
description = "This repository is used as a python API for the ThermoGIS Doublet simulations"
authors = [
    { name = "Hen Brett", email = "hen.brett@tno.nl" },
@@ -18,7 +18,9 @@ dependencies = [
    "jpype1>=1.5.2,<2",
    "xarray==2024.9.0.*",
    "pandas>=2.2.3,<3",
    "pytz>=2024.1,<2025", "build>=1.2.2.post1,<2", "pygridsio>=0.3.27,<0.4", "ruff>=0.13.0,<0.14"]
    "pytz>=2024.1,<2025",
    "build>=1.2.2.post1,<2",
    "pygridsio>=0.3.27,<0.4"]


[tool.pytest.ini_options]
+3 −5
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ def calculate_doublet_performance(reservoir_properties: xr.Dataset, utc_properti
        Optional variables:
        - transmissivity, units: Dm, if provided then permeability is ignored.
        - temperature : If not provided, temperature is estimated using the depth and a temperature gradient from `utc_properties`.
        - mask : If provided, all non-NaN values will result in setting corresponding output values to zero.
        - mask : If provided, all non-NaN values will result in setting corresponding output values to mask_value.

    utc_properties : JClass
        A Java class specifying the properties of the doublet being simulated
@@ -51,10 +51,8 @@ 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
        0.0 by default, Any cell that results in:
        1. a failed simulation
        2. failed input validation checks
        will be assigned the mask_value
        0.0 by default, Any cell that results in a failed simulation or corresponds to a
        non-nan value in the mask parameter will be assigned the mask value

    Returns
    -------
+3 −5
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ def calculate_doublet_performance_stochastic(

        Optional variables:
        - temperature : If not provided, temperature is estimated using the depth and a temperature gradient from `input_params`.
        - mask : If provided, all non-NaN values will result in setting corresponding output values to zero.
        - mask : If provided, all non-NaN values will result in setting corresponding output values to mask_value.

    utc_properties : JClass
        A Java class specifying the properties of the doublet being simulated
@@ -66,10 +66,8 @@ def calculate_doublet_performance_stochastic(
        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
        0.0 by default, Any cell that results in a failed simulation or corresponds to a
        non-nan value in the mask parameter will be assigned the mask value

    Returns
    -------
+3 −5
Original line number Diff line number Diff line
@@ -59,7 +59,7 @@ def calculate_performance_of_single_location(mask: float, depth: float, thicknes
    utc_properties : dict
        Dictionary containing UTC (Underground Thermal Capacity) properties.
    mask : float
        Mask value; if not NaN, all output values will be set to 0.0.
        Mask value; if not NaN, all output values will be set to mask_value.
    depth : float
        Depth of the aquifer in meters.
    thickness : float
@@ -77,10 +77,8 @@ def calculate_performance_of_single_location(mask: float, depth: float, thicknes
    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
        0.0 by default, Any cell that results in a failed simulation or corresponds to a
        non-nan value in the mask parameter will be assigned the mask value

    Returns
    -------