Skip to content

Latest commit

 

History

History
104 lines (51 loc) · 2.37 KB

INSTALL.rst

File metadata and controls

104 lines (51 loc) · 2.37 KB

Installation

Development installation

Pre-Requirements

The Brazil Data Cube Collectors (BDC-Collectors) depends essentially on:

Clone the software repository

Use git to clone the software repository:

git clone https://github.com/brazil-data-cube/bdc-collectors.git

Install BDC-Collectors in Development Mode

Go to the source code folder:

cd bdc-collectors

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

python3.11 -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:

sphinx-build docs/sphinx docs/sphinx/_build/html

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