Commit d4af828e authored by BorjaEst's avatar BorjaEst
Browse files

Edited second readme version

parent 8f70daee
......@@ -3,7 +3,7 @@
<img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
</p>
<h3 align="center">Project Title</h3>
<h3 align="center">o3skim</h3>
<div align="center">
......@@ -16,66 +16,75 @@
---
<p align="center"> Few lines describing your project.
<p align="center"> Data pre-processing for ozone models
<br>
</p>
## 📝 Table of Contents
# 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](../TODO.md)
- [Contributing](../CONTRIBUTING.md)
- [Installing](#Installing)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
- [TODO](https://git.scc.kit.edu/synergy.o3as/o3skim/-/issues)
## 🧐 About <a name = "about"></a>
Write about 1-2 paragraphs describing the purpose of your project.
# 🧐 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>
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them.
# 🏁 Getting Started <a name = "getting_started"></a>
See [deployment](#deployment) for notes on how to deploy the project on a live system.
```
Give examples
```
## 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)
### Installing
A step by step series of examples that tell you how to get a development env running.
> Note udocker cannot be used to build containers, only to run them.
Say what the step will be
> 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++]()
## ⛏️ 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
```
Give the example
```
And repeat
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
```
until finished
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
...
```
End with an example of getting some data out of the system or using it for a little demo.
Installation is done using
[Setuptools](https://setuptools.readthedocs.io/en/latest/setuptools.html#)
package:
- For installation from sources: `setup.py install`
- For simple installation: `pip install {name}`
## 🔧 Running the tests <a name = "tests"></a>
Explain how to run the automated tests for this system.
First install in your system without docker, after download, use pip:
```sh
$ pip install -e .
```
Tests run using
After, tests can be run using
[tox](https://tox.readthedocs.io/en/latest/)
package and
[pytest](https://docs.pytest.org/en/stable/)
to install it with pip run:
```sh
$ pip install tox
```
To start testing simply run:
```sh
$ tox
...
......@@ -83,39 +92,21 @@ py37: commands succeeded
py38: commands succeeded
```
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
# 🚀 Deployment <a name = "deployment"></a>
If an image was build using docker, then just deploy the container passing the desired arguments.
For example:
```sh
$ docker run o3skim --verbosity INFO
...TBD
```
> For arguments description you can run `docker run o3skim --help
## 🎈 Usage <a name="usage"></a>
Add notes about how to use the system.
## 🚀 Deployment <a name = "deployment"></a>
Add additional notes about how to deploy this on a live system.
## ⛏️ Built Using <a name = "built_using"></a>
- [MongoDB](https://www.mongodb.com/) - Database
- [Express](https://expressjs.com/) - Server Framework
- [VueJs](https://vuejs.org/) - Web Framework
- [NodeJs](https://nodejs.org/en/) - Server Environment
## ✍️ Authors <a name = "authors"></a>
# ✍️ Authors <a name = "authors"></a>
- [@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
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
- Hat tip to anyone whose code was used
- Inspiration
- References
# 🎉 Acknowledgements <a name = "acknowledgement"></a>
-
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