Skip to content

About

Python client to use VIP through its CARMIN API

Resources

Stars

5 stars

Watchers

3 watching

Forks

Repository files navigation

VIP-logo

Python client for the Virtual Imaging Platform (VIP), a free online platform for medical image simulation and analysis.

Now available on Pypi:

pip install vip-client

If you encounter any issues, please contact us at: vip-support@creatis.insa-lyon.fr


Prerequisites

  1. This client has been made compatible with Python 3.7+ and should work on Posix OS (e.g. Linux, Mac) and Windows. It relies on the requests (third-party) Python library.

  2. To use this client, you need a free VIP account with a valid API key. Getting a VIP account takes a few minutes following this procedure.

VipSession Quickstart

The VipSession class launches executions on VIP from any machine where the dataset is stored (e.g., one's server or PC).

from vip_client import VipSession

input_settings = {
  "file_input" : "inputs/file.ext",
  "literal_input" : "10",
}

session = VipSession.init(
  input_dir="inputs",
  pipeline_id="pipeline/x.x.x",
  input_settings=input_settings)

session.run_session()

To run:

  • with a venv either create a venv and pip install vip-client
  • with uv: uv add --script *.py vip-client and uv run *.py

To get pipeline information:

uv run --with vip-client python
VipSession.init()
VipSession.show_pipeline("BasicGrep/0.2")

See the dedicated documentation page.

The basic steps can also be learnt through a dedicated tutorial available on Binder:

Binder

Other classes

Other classes allow launching VIP executions on data stored on a girder server, or to use the VIP API directly. See the doc here or contact vip-support for more information.

Examples

Application examples can be found in this repository, including tutorials and workshop materials.

Release Notes

The release history is available here.


About

Python client to use VIP through its CARMIN API

Resources

Stars

5 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages