Merge branch '100-package-the-thermogis-jar-with-pythermogis-thus-reducing-the-installation-steps' into 'main'
Resolve "Package the thermogis jar with pythermogis, thus reducing the installation steps"
Closes #100
See merge request !124
pythermogis has been designed to be used as a python package you import into your own python projects.
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:
Because of this dependency you need to Install a Java 17 VM.
### 1. Install Java 17 and Download the ThermoGIS JAR
### 1. Install Java 17
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).
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)).
*(You can find the JAR in this repository's resources folder: /resources/thermogis_jar)*
### 2. Create Required Environment Variables
### 2. Ensure JAVA_HOME is set
Create a file called ``.env`` in your project root folder.
This file should contain the following variables:
When installing the Java 17 Virtual Machine (JVM), a global environment variable _should_ have been set: `JAVA_HOME`. This stores the path to the JVM that was installed in step 1 and enables pythermogis to read the core Java code.
If, for some reason, this was not done during installation you can either set it yourself or create a ``.env`` file in your project root folder.
This `.env` file should contain the following variable:
-`JAVA_HOME`: Path to the Java 17 installation
*(e.g., on Windows: `C:\Program Files\Amazon Corretto\jdk17.0.0_0`)*
-`THERMOGIS_JAR`: Path to the ThermoGIS `.jar` file; __including__ the name of the jar file
pythermogis has been designed to be used as a python package you import into your own python projects.
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:
Because of this dependency you need to Install a Java 17 VM.
### 1. Install Java 17 and Download the ThermoGIS JAR
### 1. Install Java 17
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).
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)).
*(You can find the JAR in this repository's resources folder: /resources/thermogis_jar.)*
*(You can find the JAR in this repository's resources folder: /resources/thermogis_jar)*
### 2. Create Required Environment Variables
### 2. Ensure JAVA_HOME is set
Create a file called ``.env`` in your project root folder.
This file should contain the following variables:
When installing the Java 17 Virtual Machine (JVM), a global environment variable _should_ have been set: `JAVA_HOME`. This stores the path to the JVM that was installed in step 1 and enables pythermogis to read the core Java code.
If, for some reason, this was not done during installation you can either set it yourself or create a ``.env`` file in your project root folder.
This `.env` file should contain the following variable:
-`JAVA_HOME`: Path to the Java 17 installation
*(e.g., on Windows: `C:\Program Files\Amazon Corretto\jdk17.0.0_0`)*
-`THERMOGIS_JAR`: Path to the ThermoGIS `.jar` file; __including__ the name of the jar file