Terarium Client

Terarium Client (mira.terarium_client)

Client functionality to Terarium.

associate(*, project_id, model_id)[source]

Associate a model (UUID) to a project (UUID) and return the association UUID.

Return type:

str

post_template_model(template_model, project_id=None)[source]

Post a template model to Terarium as a Petri Net AMR.

Optionally add to a project(s) if given.

Return type:

TerariumResponse

post_amr(amr, project_id=None)[source]

Post an AMR to Terarium.

Optionally add to a project(s) if given.

Return type:

TerariumResponse

post_amr_remote(model_url, *, project_id=None)[source]

Download an AMR from a URL then post to Terarium.

Optionally add to a project(s) if given.

To add the July 2023 evaluation scenario 3 base model to the evaluation project, run the following:

>>> post_amr_remote(
>>>     "https://raw.githubusercontent.com/indralab/mira/hackathon/"
>>>     "notebooks/evaluation_2023.07/eval_scenario3_base.json",
:rtype: :py:class:`~mira.terarium_client.TerariumResponse`

>>>     project_id="37",
>>> )
get_template_model(model_id)[source]

Get a template model from Terarium by its model UUID.

Return type:

TemplateModel