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: [email protected]

• Prerequisites
• Content
• VipSession
• Examples
• Release Notes

---

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.

Content

• The VipSession class (see below) can be used to launch VIP executions on local datasets.

• Other classes (vip_client.classes) and methods (vip_client.utils) are mostly used by the VIP team and may also fulfill specific user needs. See the doc here or contact vip-support for more information.

VipSession

from vip_client import VipSession

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

See the dedicated documentation page.

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

Examples

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

Release Notes

The release history is available here.

---