@@ -229,7 +229,7 @@ This project is licensed under the MIT License. See the `LICENSE` file for detai
---
## 🪛 Installation for Development
## 🪛 Installation for Development and Usage outside of a python package
### 🛠️ Install from Source with Pixi
@@ -240,6 +240,27 @@ pixi install
```
---
### Running the PyThermoGIS CLI
PyThermogis supports a Command Line Interface to see the available commands run the following:
```bash
pixi run pytg --help
```
Currently the main command that can be run is to run a doublet simulation on single values (no grid or arrays) for a P50 simulation. To view the help documentation run:
print("This is the pyThermoGIS Repository; it is a python API to the ThermoGIS Simulation code.")
print("You can run commands by typing:\n")
print("\t tg simulate-doublet")
@calculate.command()
@app.command()
defsimulate_doublet(
depth:float=typer.Option(500,help="The depth of the aquifer, +ive downwards, units: [m]"),
temperature:float=typer.Option(None,help="The temperature of the aquifer, if not provided this will be calculated using a Temperature gradient of 8°C + 31°C/km with the depth parameter,"),
thickness:float=typer.Option(500,help="The thickness of the aquifer, units: [m]"),
ntg:float=typer.Option(0.5,help="The net-to-gross of the aquifer, units: [0-1]"),
porosity:float=typer.Option(0.5,help="The porosity of the aquifer, between 0-1 (1 = 100%), units: [0-1]"),
permeability:float=typer.Option(0.5,help="The permeability of the aquifer, units: [mD]"),
permeability:float=typer.Option(150,help="The permeability of the aquifer, units: [mD]"),
output_file:Path=typer.Option(None,help="A file to output the data to, accepted filetypes are: .nc, .csv, .xlsx, .json"),
verbose:bool=typer.Option(False,help="print the input data and output data to terminal")
