Module for indexing BAMBOOST collections.

Uses a caching mechanism using SQLAlchemy and an SQLite database to store information about collections and simulations.

Create an instance of the Index class and use its methods to interact with the index.

>>> from bamboost.index import Index
>>> index = Index()

Scan for collections in known paths:

>>> index.scan_for_collections()

Resolve the path of a collection:

>>> index.resolve_path(<collection-uid>)

Get a simulation from its collection and simulation name:

>>> index.get_simulation(<collection-uid>, <simulation-name>)

Indexing of bamboost collections and their simulations/parameters. SQLAlchemy is used to interact with the SQLite database.

SQLAlchemy ORM models for the bamboost index database.