Certara IQ Python client

This is a Python client for the Certara IQ platform. It is useless alone and must be installed in an environment with a valid access token to a deployed Certara IQ server.

Configuration

The client searches the following paths for a configuration file:

${XDG_CONFIG_HOME:-~/.config}/certaraiq/client.toml

/etc/certaraiq/client.toml

Example configuration file:

api_origin = 'https://dev01.dev-abm.com'
iq_session_path = '/etc/certaraiq/iq_session'

• api_origin: The protocol and host for the Certara IQ server API. All requests will be made against this API. By default, the client will request against http://localhost:5200.
• iq_session_path: Path to a file containing the iq_session cookie value. The client sends it as Cookie: iq_session=<value> so the auth gateway resolves the same session the browser holds. By default, the client attempts requests with no authentication.

The search stops at the first configuration file found. If no configuration file is found, the defaults for all values are used.

Test the local client in Analyze

By default, Analyze notebooks use the PyPI certaraiq release. To use this checkout instead, deploy the local cluster with the sdk swap:

just up --swap sdk

To swap other services too, list them all, for example just up --swap backend,sdk.

Then reopen a notebook and import certaraiq. Check that certaraiq.__file__ starts with /opt/sdk/. After source edits, restart the kernel. To return to the PyPI release, run just up without the swap and reopen your notebooks.

The project environment supplies dependencies. If you change dependencies in pyproject.toml, update them in Packages too.