vip-client 0.1.0

Python client to use the Virtual Imaging Platform (VIP) through its RESTful API.

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

See the full documentation on GitHub for detailed information. If you encounter any issues, please contact us at: [e-mail]

Package Content

Several modules can be used to interact with VIP.

• Most useful methods are implemented in the Python class VipSession.
• Classes VipLauncher and VipCI are mostly used by the VIP team for current projects.
• Module utils.vip can be used for advanced requests.

The VipSession class (doc) is recommended to run simulations or massive analyses on local datasets.

from vip_client import VipSession

It also comes with a tutorial Notebook that can be used in this Binder instance:

Prerequisites

This client has been made compatible with Python 3.7+ and should work on both Posix (Linux, Mac) and Windows OS. It requires minimal preparation from the user:

1. A VIP account with a valid API key. This takes a few minutes by following this procedure.

2. The requests Python library.

pip install requests