TNO Intern

Commit b129494a authored by Hen Brett's avatar Hen Brett 🐔
Browse files

Updating the readme on how to install pythermogis

parent 2865e23c
Loading
Loading
Loading
Loading
Loading
+2 −21
Original line number Diff line number Diff line
@@ -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__:<your_personal_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 `<your_personal_token>` with the token you created above.

---

### Installation for further development
### Installation from source

Clone and install from source with Pixi: