Metadata-Version: 2.4
Name: physiboss_models
Version: 0.1.2
Summary: Library for using PhysiBoSS-Models
Author-email: Vincent Noël <vincent.noel@curie.fr>
License-Expression: MIT
Project-URL: Homepage, https://github.com/PhysiBoSS/PhysiBoSS-Models
Project-URL: Repository, https://github.com/PhysiBoSS/PhysiBoSS-Models
Project-URL: Issues, https://github.com/PhysiBoSS/PhysiBoSS-Models/issues
Requires-Python: >3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyGithub
Requires-Dist: PyYaml
Dynamic: license-file

# physiboss-models 
[![PyPI version](https://badge.fury.io/py/physiboss-models.svg)](https://badge.fury.io/py/physiboss-models)


![PhysiBoSS logo](https://avatars.githubusercontent.com/u/179001945?s=400&u=02c8638da9de9d9cd68820187adbfcb45c9d8007&v=4)

This python library provides and API to the [PhysiBoSS-Models Database](https://github.com/PhysiBoSS-Models). 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()
```
