TNO Intern

Commit dbd11abf authored by Florian Knappers's avatar Florian Knappers
Browse files

added dotenv and updated docs

parent 52478b5b

README.md

+5 −0
Original line number Diff line number Diff line
@@ -26,12 +26,17 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http 


### 2. Create Required Environment Variables



Create a file called ``.env`` in your project root folder. 

This file should contain the following variables:



- `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

  *(e.g. `/path/to/the/thermogis-1.7.0-shaded.jar`)*



Example:

![img.png](docs/images/dotenv_file_example.png)



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

docs/images/dotenv_file_example.png

0 → 100644
+42.2 KiB
Loading image diff...

docs/install/install.md

+6 −0
Original line number Diff line number Diff line
@@ -12,12 +12,18 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http 


### 2. Create Required Environment Variables



Create a file called ``.env`` in your project root folder. 

This file should contain the following variables:



- `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

  *(e.g. `/path/to/the/thermogis-1.7.0-shaded.jar`)*



Example:

![img.png](docs/images/dotenv_file_example.png)





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

pixi.lock

+15 −1
Original line number Diff line number Diff line
@@ -190,6 +190,7 @@ environments: 
      - conda: https://conda.anaconda.org/conda-forge/noarch/pytest-8.3.5-pyhd8ed1ab_0.conda

      - conda: https://conda.anaconda.org/conda-forge/linux-64/python-3.13.3-hf636f53_101_cp313.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python-dateutil-2.9.0.post0-pyhff2d567_1.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python-dotenv-1.2.1-pyhcf101f3_0.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python-gil-3.13.3-h4df99d1_101.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python-tzdata-2025.2-pyhd8ed1ab_0.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python_abi-3.13-7_cp313.conda
@@ -417,6 +418,7 @@ environments: 
      - conda: https://conda.anaconda.org/conda-forge/noarch/pytest-8.3.5-pyhd8ed1ab_0.conda

      - conda: https://conda.anaconda.org/conda-forge/win-64/python-3.13.3-h261c0b1_101_cp313.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python-dateutil-2.9.0.post0-pyhff2d567_1.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python-dotenv-1.2.1-pyhcf101f3_0.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python-gil-3.13.3-h4df99d1_101.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python-tzdata-2025.2-pyhd8ed1ab_0.conda

      - conda: https://conda.anaconda.org/conda-forge/noarch/python_abi-3.13-7_cp313.conda
@@ -4828,7 +4830,7 @@ packages: 
- pypi: ./

  name: pythermogis

  version: 1.1.2

  sha256: 47088f620c807fe8afea448a35ad74be7a39bc6f02a1fecb7ad93f21c02de4ff

  sha256: 043b1dc3f19c94485d7c1c88cfdd65bde30f3cdb479db50a6138630311c3967c

  requires_dist:

  - jpype1>=1.5.2,<2

  - xarray==2024.9.0.*
@@ -4901,6 +4903,18 @@ packages: 
  - pkg:pypi/python-dateutil?source=hash-mapping

  size: 222505

  timestamp: 1733215763718

- conda: https://conda.anaconda.org/conda-forge/noarch/python-dotenv-1.2.1-pyhcf101f3_0.conda

  sha256: aa98e0b1f5472161318f93224f1cfec1355ff69d2f79f896c0b9e033e4a6caf9

  md5: 083725d6cd3dc007f06d04bcf1e613a2

  depends:

  - python >=3.10

  - python

  license: BSD-3-Clause

  license_family: BSD

  purls:

  - pkg:pypi/python-dotenv?source=hash-mapping

  size: 26922

  timestamp: 1761503229008

- conda: https://conda.anaconda.org/conda-forge/noarch/python-gil-3.13.3-h4df99d1_101.conda

  sha256: 54a19e0ed3be0c3397301482b44008fc8d21058ebb9d17ed7046b14bda0e16f4

  md5: 82c2641f2f0f513f7d2d1b847a2588e3

pyproject.toml

+1 −0
Original line number Diff line number Diff line
@@ -66,6 +66,7 @@ mkdocstrings-python = ">=1.16.12,<2" 
dask = ">=2025.5.1,<2026"

narwhals = ">=1.43.1,<2"

pre-commit = ">=4.3.0,<5"

python-dotenv = ">=1.2.1,<2"



[tool.ruff]

line-length = 88