The Open Data Cube (ODC) framework and all its tools ecosystem are currently being tested with Brazil Data Cube (BDC) data products. This integration aims to increase the set of access, visualization, and analysis tools available to the users of the various data cubes produced by the project. This repository presents the utilities and steps for using ODC tools in the BDC data ecosystem.
The documentation contains details about each of the resources that are available in the repository. To access the documentation, generate it with the commands below.
1. Clone the documentation repository:
git clone https://github.com/brazil-data-cube/bdc-odc.git
2. Go to the source code folder:
cd bdc-odc
3. Install the required Python libraries:
pip3 install -r requirements-docs.txt
or:
pip3 install sphinx sphinx_rtd_theme sphinx-copybutton sphinx-tabs sphinx-clickor, if you prefer the Anaconda distribution:
conda install sphinx sphinx_rtd_theme sphinx-copybutton sphinx-tabs sphinx-click
4. In order to build the HTML documentation, please, go to the docs folder:
cd docs/sphinxs
5. Build the HTML documentation with the make html command:
make html
The above command will generate the HTML documentation under the _build/html folder. You can open the index.html file in order to navigate in the documentation:
firefox _build/html/index.html
Note
In order to clean the sites directory, and remove staled files, you can use the following command:
make clean
Note
In addition to the steps presented, if your system has not been installed, it is necessary to install stac2odc. See the installation page.