README.md 2.41 KB
Newer Older
BorjaEst's avatar
BorjaEst committed
1
<p align="center">
BorjaEst's avatar
BorjaEst committed
2
   <img src="https://o3as.data.kit.edu/img/header-bg.jpg" width="850" height="200">
BorjaEst's avatar
BorjaEst committed
3
4
</p>

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

<div align="center">

BorjaEst's avatar
BorjaEst committed
9
  [![Build Status](https://jenkins.eosc-synergy.eu/buildStatus/icon?job=eosc-synergy-org%2Fo3skim%2Fmaster)](https://jenkins.eosc-synergy.eu/job/eosc-synergy-org/job/o3skim/job/master)
10
  [![Documentation Status](https://readthedocs.org/projects/o3as/badge/?version=latest)](https://o3as.readthedocs.io/en/latest/?badge=latest)
11
12
13
14
  [![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
15
16
17
18
19

</div>

---

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

BorjaEst's avatar
BorjaEst committed
24
# 📝 Table of Contents
BorjaEst's avatar
BorjaEst committed
25
- [About](#about)
BorjaEst's avatar
BorjaEst committed
26
- [Documentation](https://o3as.readthedocs.io/en/latest)
BorjaEst's avatar
BorjaEst committed
27
- [Authors](#authors)
BorjaEst's avatar
BorjaEst committed
28
- [Issues & ToDo](https://git.scc.kit.edu/synergy.o3as/o3skim/-/issues)
BorjaEst's avatar
BorjaEst committed
29

30
# About <a name = "about"></a>
31
This project provides the tools to preprocess, standardize and reduce ozone data for later transfer and plot. 
BorjaEst's avatar
BorjaEst committed
32

BorjaEst's avatar
BorjaEst committed
33
## Prerequisites
BorjaEst's avatar
BorjaEst committed
34
35
This software is shipped as python3 package, therefore you need to have python3 
and pip installed. If not, please check [pip documentation](https://pip.pypa.io/en/stable/installing/) to find out how to run it in your system.
BorjaEst's avatar
BorjaEst committed
36

BorjaEst's avatar
BorjaEst committed
37
> Non admin rights? Check how to run [conda](https://docs.conda.io/en/latest/) in your machine.
BorjaEst's avatar
BorjaEst committed
38
39


BorjaEst's avatar
BorjaEst committed
40
# Testing <a name = "testing"></a>
BorjaEst's avatar
BorjaEst committed
41
Testing is based on [sqa-baseline](https://indigo-dc.github.io/sqa-baseline/) criteria. On top, [tox](https://tox.readthedocs.io/en/latest/) automation is used to simplify the testing process.
42

BorjaEst's avatar
BorjaEst committed
43
To run unit and functional tests with coverage use:
BorjaEst's avatar
BorjaEst committed
44
```sh
BorjaEst's avatar
BorjaEst committed
45
$ tox
BorjaEst's avatar
BorjaEst committed
46
```
47

BorjaEst's avatar
BorjaEst committed
48
49
50
51
52
53
54
55
56

# Documentation <a name = "doc"></a>
All o3as project module documents can be found at [o3as.readthedocs.io](https://o3as.readthedocs.io/en/latest/). 


# Authors <a name = "authors"></a>
- [@V.Kozlov](https://git.scc.kit.edu/eo9869)
- [@T.Kerzenmacher](https://git.scc.kit.edu/px5501)
- [@B.Esteban](https://git.scc.kit.edu/zr5094)
BorjaEst's avatar
BorjaEst committed
57