Skip to content

Latest commit

 

History

History
104 lines (48 loc) · 2.61 KB

INSTALL.rst

File metadata and controls

104 lines (48 loc) · 2.61 KB

Installation

Development installation

Pre-Requirements

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

  • BDC-DB: a database management extension for Brazil Data Cube Applications and Services.
  • LCCS-DB: the underlying Land Cover Classification System database model.
  • Flask-SQLAlchemy: an extension for Flask that adds support for SQLAlchemy in applications.
  • Flask-Alembic: an extension that provides a configurable Alembic migration environment around a Flask-SQLAlchemy database.
  • GeoAlchemy: an extension for SQLAlchemy for working with spatial databases.
  • py-multihash: the Multihash Implementation in Python.

Clone the software repository

Use git to clone the software repository:

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

Install BDC-Catalog in Development Mode

Go to the source code folder:

cd bdc-catalog

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

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:

doc/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