Updating the readme on how to install pythermogis

# Installation

PyThermoGIS has been designed to be used as a python package you import into your own python projects.

It works by creating python API access to the ThermoGIS techno-economic application, which is written in Java. 

Because of this dependency you need to Install a Java 17 VM and store the ThermoGIS Jar (a Java executable file):

It works by creating a python API access to the ThermoGIS techno-economic application, which is written in Java. 

Because of this dependency you need to Install a Java 17 VM and store the ThermoGIS Jar (a Java executable file) on your computer:

### 1. Install Java 17 and Download the ThermoGIS JAR

This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)) and a ThermoGIS Jar file (Version >=1.7).

This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)) and a [ThermoGIS Jar file](https://ci.tno.nl/gitlab/ags_public/pythermogis/-/blob/main/resources/thermogis_jar/thermogis-1.7.0-shaded.jar?ref_type=heads) (Version >=1.7).

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

#### 🧱 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`)*

---

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

### 3. Import pyThermoGIS into your own python projects

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

```

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

```

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

```

---

### 2b) Installation from source

### Installation from source

Clone and install from source with Pixi:

### 1. Install Java 17 and Download the ThermoGIS JAR

This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)) and a ThermoGIS Jar file (Version >=1.7).

This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)) and a [ThermoGIS Jar file](https://ci.tno.nl/gitlab/ags_public/pythermogis/-/blob/main/resources/thermogis_jar/thermogis-1.7.0-shaded.jar?ref_type=heads) (Version >=1.7).

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

### 3. Import pyThermoGIS into your own python projects

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 uv as your dependency manager:

If you are using pixi as your dependency manager

```

uv add pythermogis --default-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

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

```

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

```

---