diff --git a/README.md b/README.md index 7a348c2..bc3719d 100644 --- a/README.md +++ b/README.md @@ -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. +algorithms; Support Vector Machine (SVM) and Random Forest (RF). -## Installation using `pip` +## Installation from source Use ```git``` command to get ```cropmaps``` package and then ```pip``` package manager to install the module. @@ -13,8 +18,19 @@ git clone ...git && cd cropmaps/ pip install . ``` +## Installation from PyPI 🚧 + +This section is currently under construction. 🛠️ + ## Quickstart +