TNO Intern

Commit 3942cd71 authored by Hen Brett's avatar Hen Brett 🐔
Browse files

updating the README.md

parent 7dd8d341

README.md

+45 −37
Original line number Diff line number Diff line
@@ -48,7 +48,10 @@ This package provides a narrow access point to the doublet simulations and UTC e 


---



## Installation for use in your own projects

# Installation



PyThermoGIS has been designed to be used in one of two ways; either as a python package you import into your own python projects, or as a standalone package where you can access the calculations via a CLI.

Either way, you need to Install a Java 17 VM and store the ThermoGIS Jar:



### 1. Install Java 17 and Download the ThermoGIS JAR
@@ -65,7 +68,7 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http 


---



### 2. Install pyThermoGIS from TNO GitLab

### 2a) import pyThermoGIS into your own python projects



This repository is currently hosted privately on [ci.tno.nl](https://ci.tno.nl) and will become publicly available in the future.
@@ -92,7 +95,45 @@ pip install pythermogis --index-url https://__token__:<your_personal_token>@ci.t 


---



## Usage

### 2b) Installation for further development or Standalone usage



Clone and install from source with Pixi:



```bash

git clone https://gitlab.com/your-repo/pythermogis.git

cd pythermogis

pixi install

```

(Make sure you have followed the step installing a Java17 VM and saving the ThermoGIS Jar)



---



# Usage



PyThermoGIS has been designed to be used in one of two ways; either as a python package you import into your own python projects, or as a standalone package where you can access the calculations via a CLI.





## 1. Running the PyThermoGIS CLI



PyThermogis supports a Command Line Interface (CLI), 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:



```bash

pixi run pytg simulate-doublet --help

```



And as an example:



```bash

pixi run pytg simulate-doublet --depth 500 --temperature 150 --thickness 200 --ntg 0.45 --porosity 0.45 --permeability 200 --output-file test.csv

```



## 2. Usage in your own python projects



### 🧪 Basic Example
@@ -229,40 +270,7 @@ This project is licensed under the MIT License. See the `LICENSE` file for detai 


---



## 🪛 Installation for Development and Usage outside of a python package



### 🛠️ Install from Source with Pixi



```bash

git clone https://gitlab.com/your-repo/pythermogis.git

cd pythermogis

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:



```bash

pixi run pytg simulate-doublet --help

```



And as an example:



```bash

pixi run pytg simulate-doublet --depth 500 --temperature 150 --thickness 200 --ntg 0.45 --porosity 0.45 --permeability 200 --output-file test.csv

```







### 📦 Publish to ci.tno.nl/gitlab

### 📦 Publish to ci.tno.nl/gitlab (For developers only)



#### 1. Configure `.pypirc`