TNO Intern

Commit 3d541d18 authored by Hen Brett's avatar Hen Brett 🐔
Browse files

Improving the installation method

parent d89cb025

docs/install/install.md

+5 −3
Original line number Diff line number Diff line 
# Installation



PyThermoGIS has been designed to be used in one of two ways; either as a python package you import into your own python projects, or as a standalone package where you can access the calculations via a CLI.

Either way, you need to Install a Java 17 VM and store the ThermoGIS Jar:

PyThermoGIS has been designed to be used as a package you import into your own projects. 

A number of examples have been provided to show how to setup your own simulations and develop your own statistical frameworks.



Under the hood PyThermoGIS runs the ThermoGIS code, which is written in Java, so you need to install a Java interpreter and have a file of the ThermoGIS Jar:



## 1. Install Java 17 and Download the ThermoGIS JAR
@@ -19,7 +21,7 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http 


---



## 2a) import pyThermoGIS into your own python projects

## import pyThermoGIS into your own python projects



This repository is currently hosted privately on [ci.tno.nl](https://ci.tno.nl) and will become publicly available in the future.

mkdocs.yml

+4 −0
Original line number Diff line number Diff line
@@ -66,6 +66,10 @@ nav: 
  - API Reference:

      - doublet: reference/doublet.md

      - utc_properties: reference/utc_properties.md

      - deterministic doublet simulation: reference/doublet_simulation_deterministic.md

      - stochastic doublet simulation: reference/doublet_simulation_stochastic.md









plugins: