README.md 836 Bytes
Newer Older
matthmey's avatar
matthmey committed
1
2
# stuett

matthmey's avatar
matthmey committed
3
Disclaimer: This project is still under heavy development.
matthmey's avatar
matthmey committed
4
5
6

## Quickstart

matthmey's avatar
matthmey committed
7
8
9
10
11
12
13
14
```
pip install stuett
```

You can find examples on how to use the package [here](https://github.com/ETHZ-TEC/permafrostanalytics/).

## Install from sources
On Linux, you can install the package with
matthmey's avatar
matthmey committed
15
16
```
pip install poetry
17
poetry install
matthmey's avatar
matthmey committed
18
19
20
21
```

If you want to install it into a anaconda environment do
```
matthmey's avatar
matthmey committed
22
conda create -n stuett python==3.7 
matthmey's avatar
matthmey committed
23
conda activate stuett
matthmey's avatar
matthmey committed
24
pip install --pre poetry
matthmey's avatar
matthmey committed
25
26
poetry install
```
matthmey's avatar
matthmey committed
27
28
29
30
31
32
33
34
35


Note that there are several issues when installing on Windows
* Make sure git is installed and can be found by Anaconda! You can install git with Anaconda `conda install git curl`
* Install a Microsoft C Compiler, gcc seems to have some issues


## Versions
The versioning scheme is based on a [CalVer](https://calver.org/) using YY.MM.MICRO