diff --git a/README.md b/README.md index 116dcf45d94216c422c7e5ad1e0293dada2c4449..ed621bfbb75f84062f9061e1109e2041f04b428d 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,39 +32,31 @@ 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. - -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 +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 ``` -pip install pythermogis --index-url https://__token__:@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 ``` -replacing the `` with the token you created above. +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 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 ``` diff --git a/docs/install/install.md b/docs/install/install.md index 14a8ab803089972f8f402b74cb0ba8e4d24c1bf7..70dcdfdff93b8568fd2b5538cfd0807ac99de185 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -2,16 +2,16 @@ # 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`)* @@ -21,39 +21,31 @@ 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. - -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 +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 ``` -pip install pythermogis --index-url https://__token__:@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 ``` -replacing the `` with the token you created above. +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 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 ```