Skip to content

Commit

Permalink
Update README (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
alekfal committed Feb 1, 2024
1 parent de76249 commit 582f2ad
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# cropmaps

[![Build Status](https://github.com/rslab-ntua/cropmaps/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/rslab-ntua/cropmaps/actions/workflows/python-package.yml)
[![Documentation Status](https://readthedocs.org/projects/cropmaps/badge/?version=latest)](https://cropmaps.readthedocs.io/en/latest/?badge=latest)
[![License](https://img.shields.io/badge/License-GNU3-green.svg)](https://github.com/rslab-ntua/cropmaps)
[![codecov](https://codecov.io/gh/rslab-ntua/cropmaps/graph/badge.svg?token=36BEKVURMG)](https://codecov.io/gh/rslab-ntua/cropmaps)

MAGO `cropmaps` package is an open source Python toolbox for crop type mapping
from Sentinel-2 L2A multispectral satellite data using two well known machine learning
algorithms; SVM and Random Forest.

## Installation using `pip`
## Installation from source

Use ```git``` command to get ```cropmaps``` package and then ```pip``` package manager to install the module.

Expand All @@ -13,8 +18,17 @@ git clone ...git && cd cropmaps/
pip install .
```

## Installation from PyPI :construction

## Quickstart

<div align="center">
<figure>
<img src="./docs/images/flowchart.drawio.png" width = 700>
<figcaption>Figure 1. Flowchart of the cropmaps package.</figcaption>
</figure>
</div>

### Importing Python dependencies

For this software to run user must import in Python the following packages:
Expand Down Expand Up @@ -56,7 +70,10 @@ The first step in order to find all the available Sentinel-2 data is to use the
> :memo: User can define more variables for a more specific query. These variables can be found [here](https://scihub.copernicus.eu/twiki/do/view/SciHubUserGuide/FullTextSearch?redirectedfrom=SciHubUserGuide.3FullTextSearch).
<div align="center">
<figure>
<img src="./docs/images/ESA_query.drawio.png" width = 350>
<figcaption>Figure 2. Query to ESA servers.</figcaption>
</figure>
</div>

Then the result from query is being tested using ```check_L2``` method since the resulted Sentinel-2 data must be in atmospherically corrected L2A.
Expand Down
Binary file added docs/images/flowchart.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 582f2ad

Please sign in to comment.