Installation

Pre-Requirements

sample.py depends essentially on:

Requests Requests is a simple, yet elegant HTTP library.
Shapely Shapely is a BSD-licensed Python package for manipulation and analysis of planar geometric objects..
Geopandas GeoPandas is an open source project to make working with geospatial data in python easier.
LCCS.py Python Client for Land Cover Classification System Service.

Please, read the instructions below in order to install sample.py.

Use git to clone the software repository:

$ git clone https://github.com/brazil-data-cube/sample.py.git

Go to the source code folder:

cd sample.py

Install in development mode:

pip3 install -e .[all]

Note

If you want to create a new Python Virtual Environment, please, follow this instruction:

1. Create a new virtual environment linked to Python 3.7:

python3.7 -m venv venv

2. Activate the new environment:

source venv/bin/activate

3. Update pip and setuptools:

pip3 install --upgrade pip

pip3 install --upgrade setuptools

For more information, see 1.

Or you can use Python Anaconda Environment:

1. Create an virtual environment using conda with Python Interpreter Version +3:

conda create --name bdc-sample python=3

2. Activate environment:

conda activate bdc-sample

Run the tests:

./run-test.sh

You can generate the documentation based on Sphinx with the following command:

python setup.py build_sphinx

The above command will generate the documentation in HTML and it will place it under:

docs/sphinx/_build/html/

You can open the above documentation in your favorite browser, as:

firefox docs/sphinx/_build/html/index.html

Install from GitHub:

pip3 install git+https://github.com/brazil-data-cube/sample.py

Footnotes

Shapely 1.7 requires GEOS >=3.3, if you have a build message such as the one showed below:

OSError: /path/lib/libgeos_c.so: cannot open shared object file: No such file or directory

You can instruct pip to look at the right place for header files when building Shapely:

$LD_LIBRARY_PATH="/usr/local/lib/" \
pip3 install shapely