README.md 1.27 KB
Newer Older
1
# kis_tools #
2

3
Repo to store and manage all code related to solar datacenter file processing tasks. Documentation can be found [here](https://gitlab.leibniz-kis.de/sdc/sdc_wiki/wikis/user_manual/KIS-Tools). 
Carl Schaffer's avatar
Carl Schaffer committed
4

5
The main result of this repo is the collection of executables contained in the `bin` folder. 
Carl Schaffer's avatar
Carl Schaffer committed
6

7
8
9
10
11
12
13
14
15
16
17
18
Installation can be done using pip via
```bash
pip install kis_tools
```
from the root directory or installing directly from git using
```bash
pip install git+https://gitlab.leibniz-kis.de/sdc/kis_tools.git
```
The following commandline tools are provided by this package:  
* BBI: bbi_gen_gifs, bbi_header_conversion, bbi_preview
* GRIS: gris_gen_maps, gris_location_plot, gris_penumbral_thumbs, gris_plot_cont_corr, gris_translate_header, grisplot, gristagger
* LARS: lars_gen_preview, lars_logbook
Carl Schaffer's avatar
Carl Schaffer committed
19

20
All of them can be called from the commandline after installing the package. More information on the individual tools can be obtained using the `--help` flag
Carl Schaffer's avatar
Carl Schaffer committed
21

Carl Schaffer's avatar
Carl Schaffer committed
22
23

## Contributing
24
See the [contributing guide](https://gitlab.leibniz-kis.de/sdc/kis_tools/blob/master/CONTRIBUTING.md) for standards and code documentation recommendations.
Carl Schaffer's avatar
Carl Schaffer committed
25
26

## Python Setup
Peter Caligari's avatar
Peter Caligari committed
27
There are also instructions for setting up you python environment [here](https://gitlab.leibniz-kis.de/sdc/kis_tools/blob/master/python-setup.md)