Skip to content

PhysiBoSS-Models/physiboss-models

Repository files navigation

physiboss-models

PyPI version

PhysiBoSS logo

This python library provides and API to the PhysiBoSS-Models Database. You can list models, look at their metadata, and download them.

Install

pip install physiboss-models

Usage

To start, you need to create the Database object:

import physiboss_models as pm
db = pm.DataBase()

List models

models = db.all()

Search models

models = db.search("invasion")

List versions of a model

versions = db.versions(model)

Download model

db.download_model(model, path, version)

This will download a model (pre-compiled binary, config files) into the informed path. You can soecify a version, if you don't it will download the latest one.

Once loaded, you can access the model metadata with

metadata = db.current_model_info()