Commit 45620b4b authored by BorjaEst's avatar BorjaEst
Browse files

Update readme

parent 1fea437f
......@@ -7,7 +7,7 @@
<div align="center">
[![Build Status](](
[![Build Status](](
[![Documentation Status](](
[![pipeline status](](
[![coverage status](](
......@@ -24,90 +24,20 @@
# 📝 Table of Contents
- [About](#about)
- [Build using docker](#build)
- [Run using udocker](#deployment)
- [Testing](#testing)
- [Documentation](
- [Authors](#authors)
- [TODO](
- [Issues & ToDo](
# About <a name = "about"></a>
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:
- __Build machine__ with [docker](
- __Runtime machine__ with [udocker](
This software is shipped as python3 package, therefore you need to have python3
and pip installed. If not, please check [pip documentation]( to find out how to run it in your system.
> Note udocker cannot be used to build containers, only to run them.
> Non admin rights? Check how to run [conda]( in your machine.
# Built using docker <a name = "build"></a>
Download the repository at the __Build machine__ using git.
$ git clone
Cloning into 'o3skim'...
Build the docker image at the __Build machine__ using docker.
$ docker build --tag o3skim .
Successfully built 69587025a70a
Successfully tagged o3skim:latest
If the build process succeeded, you can list the image on the docker image list:
$ docker images
o3skim latest 69587025a70a xx seconds ago 557MB
# 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 description at the input path in [YAML]( format.
This configuration file has to be mounted on `/app/sources.yaml` inside the container.
Once the requirement are completed, pull the image from the image registry.
For example, to pull it from the synergy-imk official registry use:
$ udocker pull synergyimk/o3skim
Downloading layer: sha256:a3ed95caeb02ffe68cdd9fd84406680ae93d633cb16422d00e8a7c22955b46d4
Once the repository is added and the image downloaded, create the local container:
$ udocker create --name=o3skim synergyimk/o3skim
Finally, run the container. Note the described _data_, _output_ and _sources.yaml_ have to be provided. Also it is needed to specify the user _application_ should run inside the container:
$ udocker run \
--user=application \
--volume=${PWD}/sources.yaml:/app/sources.yaml \
--volume=${PWD}/data:/app/data \
--volume=${PWD}/output:/app/output \
o3skim --verbosity INFO ${action1} ${action2}
executing: main
2020-08-25 12:42:34,151 - INFO - Configuration found at: './sources.yaml'
2020-08-25 12:42:34,152 - INFO - Loading data from './data'
2020-08-25 12:42:34,261 - INFO - Skimming data to './output'
For the main function description and commands help you can call:
$ udocker run --user=application o3skim --help
# Testing <a name = "testing"></a>
Testing is based on [sqa-baseline]( criteria. On top, [tox]( automation is used to simplify the testing process.
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