README.md 3.79 KB
Newer Older
BorjaEst's avatar
BorjaEst committed
1
2
3
4
5
<p align="center">
  <a href="" rel="noopener">
 <img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
</p>

BorjaEst's avatar
BorjaEst committed
6
<h3 align="center">o3skim</h3>
BorjaEst's avatar
BorjaEst committed
7
8
9

<div align="center">

10
11
12
13
  [![pipeline status](https://git.scc.kit.edu/synergy.o3as/o3skim/badges/master/pipeline.svg)](https://git.scc.kit.edu/synergy.o3as/o3skim/-/commits/master)
  [![coverage status](https://git.scc.kit.edu/synergy.o3as/o3skim/badges/master/coverage.svg)](https://git.scc.kit.edu/synergy.o3as/o3skim/-/commits/master)
  [![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://git.scc.kit.edu/synergy.o3as/o3skim/-/commits/master)
  [![Status](https://img.shields.io/badge/status-building-blue.svg)](https://git.scc.kit.edu/synergy.o3as/o3skim/-/commits/master) 
BorjaEst's avatar
BorjaEst committed
14
15
16
17
18

</div>

---

BorjaEst's avatar
BorjaEst committed
19
<p align="center"> Data pre-processing for ozone models 
BorjaEst's avatar
BorjaEst committed
20
21
22
    <br> 
</p>

BorjaEst's avatar
BorjaEst committed
23
# 📝 Table of Contents
BorjaEst's avatar
BorjaEst committed
24
25
26
27
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Built Using](#built_using)
BorjaEst's avatar
BorjaEst committed
28
- [Installing](#Installing)
BorjaEst's avatar
BorjaEst committed
29
30
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
BorjaEst's avatar
BorjaEst committed
31
- [TODO](https://git.scc.kit.edu/synergy.o3as/o3skim/-/issues)
BorjaEst's avatar
BorjaEst committed
32

BorjaEst's avatar
BorjaEst committed
33
34
# 🧐 About <a name = "about"></a>
This project provides the tools to preprocess, standarise and reduce ozone data for later transfer and plot. 
BorjaEst's avatar
BorjaEst committed
35
36


BorjaEst's avatar
BorjaEst committed
37
38
# 🏁 Getting Started <a name = "getting_started"></a>
See [deployment](#deployment) for notes on how to deploy the project on a live system.
BorjaEst's avatar
BorjaEst committed
39

BorjaEst's avatar
BorjaEst committed
40
41
42
43
## Prerequisites
To run the project as container, install one of the following container technologies in your system:
- [docker](https://docs.docker.com/engine/install/)
- [udocker](https://indigo-dc.gitbook.io/udocker/installation_manual)
BorjaEst's avatar
BorjaEst committed
44

BorjaEst's avatar
BorjaEst committed
45
> Note udocker cannot be used to build containers, only to run them. 
BorjaEst's avatar
BorjaEst committed
46

BorjaEst's avatar
BorjaEst committed
47
48
49
50
51
> For local install and testing you need at least:
- [python 3.8](https://www.python.org/downloads/release/python-385/)
- [pip 20.0.2](https://pypi.org/)
- [gcc](https://gcc.gnu.org/)
- [g++]()
BorjaEst's avatar
BorjaEst committed
52

BorjaEst's avatar
BorjaEst committed
53
54
55
56
## ⛏️ Built using docker <a name = "built_using"></a>
Download the repository using git.
```sh
$ git clone git@git.scc.kit.edu:synergy.o3as/o3skim.git
BorjaEst's avatar
BorjaEst committed
57
```
BorjaEst's avatar
BorjaEst committed
58
59
60
61
62
63
64
To run as container, installation is not needed, however an image has to be build (if not downloaded form the official repository).
To build it using docker, run the following command:
```sh
$ docker build --tag o3skim .
...
Successfully built 69587025a70a
Successfully tagged o3skim:latest
BorjaEst's avatar
BorjaEst committed
65
```
BorjaEst's avatar
BorjaEst committed
66
67
68
69
70
71
If the build process succeded, you can list the image on the docker image list:
```sh
$ docker images
REPOSITORY                         TAG                 IMAGE ID            CREATED              SIZE
o3skim                             latest              69587025a70a        xx seconds ago      557MB
...
BorjaEst's avatar
BorjaEst committed
72
73
74
```

## 🔧 Running the tests <a name = "tests"></a>
BorjaEst's avatar
BorjaEst committed
75
76
77
78
First install in your system without docker, after download, use pip:
```sh
$ pip install -e .
```
BorjaEst's avatar
BorjaEst committed
79

BorjaEst's avatar
BorjaEst committed
80
After, tests can be run using 
81
[tox](https://tox.readthedocs.io/en/latest/)
BorjaEst's avatar
BorjaEst committed
82
83
84
85
to install it with pip run:
```sh
$ pip install tox
```
86

BorjaEst's avatar
BorjaEst committed
87
To start testing simply run:
88
89
90
91
92
93
94
```sh
$ tox
...
py37: commands succeeded
py38: commands succeeded
```

BorjaEst's avatar
BorjaEst committed
95
96
97
98
# 🚀 Deployment <a name = "deployment"></a>
If an image was build using docker, then just deploy the container passing the desired arguments.
For example:
```sh
BorjaEst's avatar
BorjaEst committed
99
100
101
102
103
104
105
106
107
$ docker run \
  -v ${PWD}/sources.yaml:/app/sources.yaml \
  -v ${PWD}/data:/app/data \
  -v ${PWD}/output:/app/output \
  o3skim --verbosity INFO
...
INFO:root:Configuration found at: './sources.yaml'
INFO:root:Loading data from './data' 
INFO:root:Skimming data to './output' 
BorjaEst's avatar
BorjaEst committed
108
```
BorjaEst's avatar
BorjaEst committed
109
For arguments description you can run `docker run o3skim --help`
BorjaEst's avatar
BorjaEst committed
110
111


BorjaEst's avatar
BorjaEst committed
112
# ✍️ Authors <a name = "authors"></a>
113
114
115
- [@V.Kozlov](https://git.scc.kit.edu/eo9869) - TBD
- [@T.Kerzenmacher](https://git.scc.kit.edu/px5501) - TBD
- [@B.steban](https://git.scc.kit.edu/zr5094) - TBD
BorjaEst's avatar
BorjaEst committed
116

BorjaEst's avatar
BorjaEst committed
117
118
# 🎉 Acknowledgements <a name = "acknowledgement"></a>
- 
BorjaEst's avatar
BorjaEst committed
119