Installation

Installation#

How to install#

You can install or upgrade Files Collection using the conda install command:

conda install files_collections -c conda-forge

This will install a minimal set of dependencies required to run Files Collections similar to python -m pip install files-collections

In order to activate the optional features (see. Optional dependencies) and get a full installation, additional packages are needed:

conda install files_collections shapely geopandas pyinterp dask numba -c conda-forge

This will install a set of dependencies similar to python -m pip install files-collections[geo]

You can install or upgrade Files Collection using the pip install command:

pip install files-collections

This will install a minimal set of dependencies required to run Files Collections similar to conda install files_collections -c conda_forge

In order to activate the optional features (see. Optional dependencies) and get a full installation, pyinterp installation requirements for building from source must be fullfilled. Then, the full installation can be triggered with:

python -m pip install files-collections[geo]

pyinterp installation requirements can be skipped if the package has already been installed via conda

Optional dependencies#

Specific functionality in Files Collections may require optional dependencies. These optional dependencies and their associated functionalities are listed below.

Dependency

Description

dask

Activate map() method in collections, Enable parallel file reading

geopandas

Enable geometry intersection, introduce the bbox argument in the query() method

numba

Enable geometry intersection, introduce the bbox argument in the query() method

pyinterp

Enable geometry intersection, introduce the bbox argument in the query() method

shapely

Enable geometry intersection, introduce the bbox argument in the query() method