TNO Intern

Commit 3d0d255c authored by Hen Brett's avatar Hen Brett 🐔
Browse files

Updating the documentation

parent 72a9c1cc

docs/index.md

+1 −1
Original line number Diff line number Diff line
@@ -50,7 +50,7 @@ It uses [xarray](https://docs.xarray.dev/en/stable/index.html) to handle input a 
This module can be combined with the [pygridsio](https://pypi.org/project/pygridsio/) package to read and process 2D raster data.



## What can this package *not* do?

This package provides a narrow access point to the doublet simulations and UTC economic calculations from ThermoGIS, it does not implement the following ThermoGIS processes/methodologies:

This package provides a narrow access point to the doublet simulations and UTC (Unit technical costs) economic calculations from ThermoGIS, it does not implement the following ThermoGIS processes/methodologies:



- Stacking of Aquifers

- Calculation of Potential maps

docs/usage/contents.md

+1 −0
Original line number Diff line number Diff line
@@ -10,6 +10,7 @@ The underlying theory of the geothermal doublet simulation is explained in the [ 
- [customized properties](customized_props.md) page explains how to customize the techno-economic properties of the simulation.

- [map run and analysis](maprun_analysis.md) page demonstrating running on maps, including some plotting examples to illustrate the outputs.

- [portfolio run and analysis](portfoliorun_analysis.md) page demonstrating running on a portfolio of prospective locations, including some plotting examples to illustrate the outputs.

- [customised stochastic simulation](customised_stochastic_simulations.md) page demonstrates how to develop your own stochastic frameworks around the core pythermogis doublet simulation functionality.



!!! info "Plotting, calculations and result analysis"

    pyThermoGIS is designed to enable users to run geothermal doublet simulations.

docs/usage/general_stochastic_methodology.md→docs/usage/customised_stochastic_simulations.md

+1 −1
Original line number Diff line number Diff line 
## Other statistical Implementations

## Customised stochastic simulations



The ThermoGIS methodology `calculate_doublet_performance_stochastic` assumes that we know the net-to-gross, porosity and depth of the aquifer and simulates doublets over a range of values for transmissivity (calculated from permeability and thickness).

There are two main reasons for selecting this statistical framework:

mkdocs.yml

+1 −1
Original line number Diff line number Diff line
@@ -60,7 +60,7 @@ nav: 
      - customized properties: usage/customized_props.md

      - map run and analysis: usage/maprun_analysis.md

      - potrfolio run and analysis: usage/portfoliorun_analysis.md

      - general stochastic methodology: usage/general_stochastic_methodology.md

      - customised stochastic simulations: usage/customised_stochastic_simulations.md

      #- out maps and locations: usage/pvalues_map_locations.md



  - API Reference:

src/pythermogis/doublet_simulation/deterministic_doublet.py

+2 −2
Original line number Diff line number Diff line
@@ -88,9 +88,9 @@ def calculate_doublet_performance(reservoir_properties: xr.Dataset, utc_properti 


    # Setup output_data dataset as a copy of reservoir properties

    output_data = reservoir_properties.copy()



    output_data = simulate_doublet(output_data, reservoir_properties, rng_seed, utc_properties)

    if print_execution_duration: print(f"Doublet simulation took {timeit.default_timer() - start:.1f} seconds")

    return simulate_doublet(output_data, reservoir_properties, rng_seed, utc_properties)

    return output_data



def validate_input(reservoir_properties: xr.Dataset):

    """