Commit 6eaf8971 authored by BorjaEst's avatar BorjaEst
Browse files

Simplify README file, details moved to docs

parent 322633f4
......@@ -22,20 +22,15 @@
# 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Built Using](#built_using)
- [Installing](#Installing)
- [Build using docker](#build)
- [Run using udocker](#deployment)
- [Documentation](#doc)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
- [TODO](https://git.scc.kit.edu/synergy.o3as/o3skim/-/issues)
# About <a name = "about"></a>
This project provides the tools to preprocess, standarise and reduce ozone data for later transfer and plot.
# Getting Started <a name = "getting_started"></a>
See [deployment](#deployment) for notes on how to deploy the project on a live system.
This project provides the tools to preprocess, standardize and reduce ozone data for later transfer and plot.
## Prerequisites
To run the project as container, you need the following systems and container technologies:
......@@ -45,7 +40,7 @@ To run the project as container, you need the following systems and container te
> Note udocker cannot be used to build containers, only to run them.
## Built using docker <a name = "built_using"></a>
# Built using docker <a name = "build"></a>
Download the repository at the __Build machine__ using git.
```sh
$ git clone git@git.scc.kit.edu:synergy.o3as/o3skim.git
......@@ -59,7 +54,7 @@ $ docker build --tag o3skim .
Successfully built 69587025a70a
Successfully tagged o3skim:latest
```
If the build process succeded, you can list the image on the docker image list:
If the build process succeeded, you can list the image on the docker image list:
```sh
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
......@@ -67,42 +62,14 @@ o3skim latest 69587025a70a xx se
...
```
## 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:
```sh
$ pip install -e .
```
Tests should run using
[tox](https://tox.readthedocs.io/en/latest/).
To install it with pip use:
```sh
$ pip install tox
```
To start testing simply run:
```sh
$ tox
...
py37: commands succeeded
py38: commands succeeded
```
# Deployment <a name = "deployment"></a>
# Run using udocker <a name = "deployment"></a>
To deploy the the application using __udocker__ at the __Runtime machine__ you need:
- Input path with data to skim, to be mounter on `/app/data` inside the container.
- Output path for skimmed results, to be mounted on `/app/output` inside the container.
- Configuration file with a data structure desctiption at the input path in [YAML](https://yaml.org/) format. This configuration file has to be mounted on `/app/sources.yaml` inside the container. See [sources_example.yaml](/sources_example.yaml) for a configuration example.
- Configuration file with a data structure description at the input path in [YAML](https://yaml.org/) format.
This configuration file has to be mounted on `/app/sources.yaml` inside the container.
Once the requierement are needed, pull the image from the image registry.
Once the requirement are completed, pull the image from the image registry.
For example, to pull it from the synergy-imk official registry use:
```sh
$ udocker pull synergyimk/o3skim
......@@ -140,11 +107,16 @@ $ udocker run --user=application o3skim --help
```
# Documentation <a name = "doc"></a>
- [TODO]()
# Authors <a name = "authors"></a>
- [@V.Kozlov](https://git.scc.kit.edu/eo9869) - TBD
- [@T.Kerzenmacher](https://git.scc.kit.edu/px5501) - TBD
- [@B.Esteban](https://git.scc.kit.edu/zr5094) - TBD
# Acknowledgements <a name = "acknowledgement"></a>
-
# For more information see the documentation at
# ./docs/user_guide/source-file.rst
CCMI-1:
IPSL:
tco3_zm:
name: toz
paths: Ccmi/mon/toz/*.nc
coordinades:
time: time
lat: lat
lon: lon
vmro3_zm:
name: vmro3
paths: Ccmi/mon/toz/*.nc
coordinades:
time: time
plev: plev
lat: lat
lon: lon
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment