README.md 3.81 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

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


37
# Getting Started <a name = "getting_started"></a>
BorjaEst's avatar
BorjaEst committed
38
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
47


48
## Built using docker <a name = "built_using"></a>
BorjaEst's avatar
BorjaEst committed
49
50
51
Download the repository using git.
```sh
$ git clone git@git.scc.kit.edu:synergy.o3as/o3skim.git
BorjaEst's avatar
BorjaEst committed
52
```
BorjaEst's avatar
BorjaEst committed
53
54
55
56
57
58
59
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
60
```
BorjaEst's avatar
BorjaEst committed
61
62
63
64
65
66
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
67
68
```

69
70
71
72
73
74
75
76
77
78
## Running the tests <a name = "tests"></a>
To run tests, you need to install the tool in your system without docker.

As first step ensure you have the following dependencies:
- [python 3.8](https://www.python.org/downloads/release/python-385/)
- [pip 20.0.2](https://pypi.org/)
- [gcc](https://gcc.gnu.org/)
- [g++]()

After download and dependencies check, install with pip:
BorjaEst's avatar
BorjaEst committed
79
80
81
```sh
$ pip install -e .
```
BorjaEst's avatar
BorjaEst committed
82

83
84
85
Tests should run using 
[tox](https://tox.readthedocs.io/en/latest/).
To install it with pip use:
BorjaEst's avatar
BorjaEst committed
86
87
88
```sh
$ pip install tox
```
89

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

98
# Deployment <a name = "deployment"></a>
BorjaEst's avatar
BorjaEst committed
99
100
101
If an image was build using docker, then just deploy the container passing the desired arguments.
For example:
```sh
BorjaEst's avatar
BorjaEst committed
102
103
104
105
106
107
108
109
110
$ 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
111
```
BorjaEst's avatar
BorjaEst committed
112
For arguments description you can run `docker run o3skim --help`
BorjaEst's avatar
BorjaEst committed
113
114


115
# Authors <a name = "authors"></a>
116
117
118
- [@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
119

120
# Acknowledgements <a name = "acknowledgement"></a>
BorjaEst's avatar
BorjaEst committed
121
- 
BorjaEst's avatar
BorjaEst committed
122