Installation Guide#
Installing with pip#
Requires Python >=3.11, <3.15.
pip install fleche
Installing with conda#
fleche is also available on conda-forge. Two
packages are published:
fleche-base– the core library only (no optional dependencies).fleche– the full install, which also pulls in the optional dependencies (cloudpickle,dill,sqlalchemyandbagofholding), enabling the SQL, SSH, alternate-serialization and Bagofholding features (see thesshrow below for the extra runtime requirement it carries).
# Core library only
conda install -c conda-forge fleche-base
# Full install with all optional dependencies
conda install -c conda-forge fleche
Optional dependencies#
The core install is deliberately lean. Extra features are gated behind optional
dependencies, exposed as pip extras. Install one or more by listing them in
brackets, e.g. pip install "fleche[sqlalchemy,ssh]".
Extra |
Install |
Enables |
|---|---|---|
|
|
The |
|
|
The |
|
|
The SQL call-storage backend ( |
|
|
The HDF5 storage backend ( |
|
|
|
|
|
Running cached calls through executorlib executors for cluster/parallel execution (see Parallel Execution). |
|
|
The packages needed to build this documentation (see below). |
|
|
The full test suite plus every optional backend it exercises. |
Note
The conda-forge fleche metapackage covers the cloudpickle, dill,
sqlalchemy, bagofholding and ssh features in one install. The
executorlib, docs and tests extras are pip-only – install
executorlib from conda-forge separately if you need it.
Companion packages#
Digest support for third-party libraries ships as separate companion packages
that register themselves via entry points —
installing them alongside fleche is all that is needed:
fleche-ase(PyPI) — digest hooks for the Atomic Simulation Environment. See Entry Points for exactly which types it covers.
pip install fleche-ase
Installing documentation#
pip install "fleche[docs]"
If you are developing the project in an editable checkout, use:
pip install -e ".[docs]"
Building the docs locally#
Once the optional dependencies are installed you can build the documentation locally with:
sphinx-build -b html docs/ docs/_build/html
Open docs/_build/html/index.html in a browser to view the site.