TNO Intern

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

Updating the readme on how to install pythermogis

parent bbfa196c
Loading
Loading
Loading
Loading
Loading
+12 −23
Original line number Diff line number Diff line
@@ -2,8 +2,8 @@
# 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

@@ -11,7 +11,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/).)*

#### 🧱 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`)*
@@ -21,39 +21,28 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http

---

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

This repository is currently hosted privately on [ci.tno.nl](https://ci.tno.nl) and is only accessible to TNO employees. The intention is that this package will become publicly available in the near future. 
You can use pip to install the package directly from the gitlab project:

Until then, you will need to use Gitlab API keys to use this module:

#### 🔐 Step-by-step Installation

##### a. Create a Personal Access Token (PAT)

1. Log in to the TNO GitLab.
2. Navigate to **Preferences > Access Tokens**.
3. Create a token with the following scopes:
   - `read_api`
   - `read_package_registry`
4. Copy and store the token securely (you won’t be able to see it again).

##### b. Install pyThermoGIS using pip
```
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:
```
pip install pythermogis --index-url https://__token__:<your_personal_token>@ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple
uv add pythermogis --default-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple
```

replacing the `<your_personal_token>` with the token you created above.

---

### Installation for further development
### Installation from source

Clone and install from source with Pixi:

```bash
git clone https://gitlab.com/your-repo/pythermogis.git
git clone git@ci.tno.nl:ags_public/pythermogis.git
cd pythermogis
pixi install
```