From b129494af7958968740e6f5cbfec7c9d9e570360 Mon Sep 17 00:00:00 2001 From: bretth Date: Tue, 14 Oct 2025 10:27:07 +0200 Subject: [PATCH 1/4] Updating the readme on how to install pythermogis --- README.md | 23 ++--------------------- 1 file changed, 2 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 116dcf4..d846c2d 100644 --- a/README.md +++ b/README.md @@ -34,32 +34,13 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http ### 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. - -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://__token__:@ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple +pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple ``` -replacing the `` with the token you created above. - --- -### Installation for further development +### Installation from source Clone and install from source with Pixi: -- GitLab From bbfa196cfb0bce1ca991645a28f701fa7fb5829c Mon Sep 17 00:00:00 2001 From: bretth Date: Tue, 14 Oct 2025 10:30:13 +0200 Subject: [PATCH 2/4] Updating the readme on how to install pythermogis --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d846c2d..8467d19 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http --- -### Import pyThermoGIS into your own python projects +### 2a) Import pyThermoGIS into your own python projects ``` pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple @@ -40,12 +40,12 @@ pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/182 --- -### Installation from source +### 2b) 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 ``` -- GitLab From cc3c51bc255db4cd2e1ed29866d1d9295f4d676c Mon Sep 17 00:00:00 2001 From: bretth Date: Tue, 14 Oct 2025 11:31:38 +0200 Subject: [PATCH 3/4] Updating the readme on how to install pythermogis --- docs/install/install.md | 35 ++++++++++++----------------------- 1 file changed, 12 insertions(+), 23 deletions(-) diff --git a/docs/install/install.md b/docs/install/install.md index 14a8ab8..262f159 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -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__:@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 `` 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 ``` -- GitLab From 745dae1b468ad7d0b36d044c24c01fe0cf678966 Mon Sep 17 00:00:00 2001 From: bretth Date: Tue, 14 Oct 2025 11:37:03 +0200 Subject: [PATCH 4/4] Updating the readme on how to install pythermogis --- README.md | 23 +++++++++++++++++------ docs/install/install.md | 11 +++++++---- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8467d19..ed621bf 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,16 @@ pixi run mkdocs serve # 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`)* @@ -32,15 +32,26 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http --- -### 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: diff --git a/docs/install/install.md b/docs/install/install.md index 262f159..70dcdfd 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -7,7 +7,7 @@ Because of this dependency you need to Install a Java 17 VM and store the Thermo ### 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/).)* @@ -24,16 +24,19 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http ### 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 +``` --- -- GitLab