TNO Intern

Commit bd7021b3 authored by Hen Brett's avatar Hen Brett 🐔
Browse files

Updating the readme on how to install pythermogis

parent 3a611e68

README.md

+4 −5
Original line number Diff line number Diff line
@@ -10,6 +10,8 @@ If you wish to build the documentation locally, follow the installation steps an 
pixi run mkdocs serve

```



---



# Installation



PyThermoGIS has been designed to be used as a python package you import into your own python projects.
@@ -22,7 +24,7 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http 


*(You can find the JAR in this repository's resources folder or request it via the [ThermoGIS website](https://www.thermogis.nl/).)*



#### 2. Create Required Environment Variables

### 2. Create Required Environment Variables



- `JAVA_HOME`: Path to the Java 17 installation

  *(e.g., on Windows: `C:\Program Files\Amazon Corretto\jdk17.0.0_0`)*
@@ -30,7 +32,6 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http 
- `THERMOGIS_JAR`: Path to the ThermoGIS `.jar` file; __including__ the name of the jar file

  *(e.g. `/path/to/the/thermogis-1.7.0-shaded.jar`)*



---



### 3. Import pyThermoGIS into your own python projects
@@ -39,7 +40,7 @@ You can use pip to install the package directly from the gitlab project: 
pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

```



If you are using pixi as your dependency manager

If you are using pixi as your dependency manager:

```

pixi run pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

```
@@ -49,8 +50,6 @@ If you are using uv as your dependency manager: 
uv add pythermogis --default-index https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

```



---



### Installation from source



Clone and install from source with Pixi:

docs/install/install.md

+3 −7
Original line number Diff line number Diff line 


# Installation



PyThermoGIS has been designed to be used as a python package you import into your own python projects.
@@ -11,7 +10,7 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http 


*(You can find the JAR in this repository's resources folder or request it via the [ThermoGIS website](https://www.thermogis.nl/).)*



#### 2. Create Required Environment Variables

### 2. Create Required Environment Variables



- `JAVA_HOME`: Path to the Java 17 installation

  *(e.g., on Windows: `C:\Program Files\Amazon Corretto\jdk17.0.0_0`)*
@@ -19,7 +18,6 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http 
- `THERMOGIS_JAR`: Path to the ThermoGIS `.jar` file; __including__ the name of the jar file

  *(e.g. `/path/to/the/thermogis-1.7.0-shaded.jar`)*



---



### 3. Import pyThermoGIS into your own python projects
@@ -28,7 +26,7 @@ You can use pip to install the package directly from the gitlab project: 
pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

```



If you are using pixi as your dependency manager

If you are using pixi as your dependency manager:

```

pixi run pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

```
@@ -38,8 +36,6 @@ If you are using uv as your dependency manager: 
uv add pythermogis --default-index https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

```



---



### Installation from source



Clone and install from source with Pixi:

mkdocs.yml

+1 −0
Original line number Diff line number Diff line
@@ -61,6 +61,7 @@ nav: 
      - map run and analysis: usage/maprun_analysis.md

      - potrfolio run and analysis: usage/portfoliorun_analysis.md

      - customised stochastic simulations: usage/customised_stochastic_simulations.md

      - parallelzation: usage/parallelization.md

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



  - API Reference:

pixi.lock

+2 −2
Original line number Diff line number Diff line
@@ -4827,8 +4827,8 @@ packages: 
  timestamp: 1740946648058

- pypi: ./

  name: pythermogis

  version: 1.1.1

  sha256: 77448402bd1f149d14b6ef577dd4e1b1f200c2b6f0e20c782f73fd5f55824804

  version: 1.1.2

  sha256: 47088f620c807fe8afea448a35ad74be7a39bc6f02a1fecb7ad93f21c02de4ff

  requires_dist:

  - jpype1>=1.5.2,<2

  - xarray==2024.9.0.*