Skip to content

Latest commit

 

History

History
123 lines (66 loc) · 3.07 KB

INSTALL.rst

File metadata and controls

123 lines (66 loc) · 3.07 KB

Installation

The Cube Builder AWS depends essentially on:

Compatibility

Cube-Builder-AWS BDC-Catalog
0.8.2 0.8.2
0.8.0 ~ 0.8.1 0.8.1
0.6.x 0.8.1
0.4.x 0.8.1

Clone the software repository

Use git to clone the software repository:

git clone https://github.com/brazil-data-cube/cube-builder-aws.git

Install Cube-Builder-AWS in Development Mode

Go to the source code folder:

$ cd cube-builder-aws

Install in development mode:

$ pip3 install -e .[docs,tests]

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.8:

python3.8 -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

Build the Documentation

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