Utilitarios para BioModelos
- Python (v. 3.8+)
- Librerías del sistema de GDAL (si instala usando Conda no es necesario)
Por facilidad en la instalación de dependencias del sistema, se recomienda usar Conda para la instalación de la herramienta.
-
Instalar conda
-
Instalar dependencias del ambiente del repositorio:
conda env create --file condaenv.yml -
Activar el ambiente recién restaurado
conda activate bm-db-utils -
Instalar la herramienta:
pip install git+https://github.com/PEM-Humboldt/biomodelos-db-utils.git#egg=bmdbutils
En este momento tendrá disponible el comando bmdbutils.
En futuras ocasiones cuando desee usar la herramienta primero deberá activar el ambiente de conda (conda activate bm-db-utils), podrá hacerlo desde cualquier ubicación.
Si lo desea, puede crear un ambiente virtual para trabajar con la herramienta sin afectar su ambiente general, para esto:
- Cree el ambiente:
python3 -m venv bmdbutils- Active el ambiente:
source bmdbutils/bin/activate
Si está usando una versión de Python >= 3.9, primero instale setuptools versión 58:
pip install setuptools==58
Puede instalar bmdbutils ejecutando el siguiente comando:
pip install git+https://github.com/PEM-Humboldt/biomodelos-db-utils.git#egg=bmdbutils
Si no tiene git, ejecute:
pip install --upgrade https://github.com/PEM-Humboldt/biomodelos-db-utils/tarball/master
Para asegurarse que bmdbutils haya quedado instalado, ejecute:
python -c "import bmdbutils"
Si la instalación fue exitosa, el comando correrá sin ningún problema.
Ejecute el comando bmdbutils para ver los subcomandos disponibles y la ayuda de los mismos.
Para el desarrollo se requiere Conda, que se encarga de crear el ambiente de desarrollo, instalar dependencias base (para no tener que instalar librerías del sistema operativo) e instalar poetry, gestor de empaquetado y manejador de las demás dependencias.
En primer lugar, es necesario clonar este repositorio localmente. Para esto, ejecute:
git clone https://github.com/PEM-Humboldt/biomodelos-db-utils.git
Luego, ubíquese dentro del directorio del proyecto:
cd biomodelos-db-utils
y restaure el ambiente de conda:
conda env create --file condaenv.yml
después, active el ambiente recién restaurado
conda activate bm-db-utils
e instale el resto de dependencias necesarias:
poetry install
En caso de necesitar agregar nuevas dependencias, ejecute:
poetry add <dependencia>
poetry update
Para ejecutar bmdbutils sin tener que instalar como usuario final ejecute
poetry run bmdbutils
Es recomendable familiarizarse con la documentación de poetry y de conda.