Skip to content
IncQuery Server Client Extensions for Jupyter and Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
example-notebook-home #8 improve html report export Jul 19, 2019
source/incqueryserver-jupyter #8 improve html report export Jul 19, 2019
.gitignore #1 Add experimental Conda packaging May 24, 2019 Initial stage. No proper packaging yet. May 17, 2019 add 'develop' binder shield Jul 6, 2019

Python and Jupyter Client Extensions for the IncQuery Server

Binder Binder (develop branch)

Requires IncQuery Server (IQS) to operate.

Try it first

Click the binder shield above to spin up a deployment publicly hosted on MyBinder, with wired-in guest access to a public IQS demo instance and the OpenMBEE public MMS model repository.

Getting started

Assuming that you have cloned this repository to your computer at path ${this-git-repo}, the following instructions will help you get the Jupyter extensions running.

Using Conda

  1. Make sure Miniconda3/Anaconda is installed, along with Python 3.7+ and the conda package manager

  2. Make sure Jupyter is installed:

     conda install jupyter

    See details at:

  3. The main dependency of the Jupyter client extension is the automatically generated Python-based IQS API client. Locate the Python client library hosted at your IQS installation; e.g. the library accompanying the public IQS demo server is available at for installation. Install this sdist using pip from your Anaconda console:

     pip install ${address-of-python-client-sdist}
  4. Designate a location as the notebook home, where notebook files will be stored. For example, use ${this-git-repo}/example-notebook-home.

  5. Ensure that the non-generated Jupyter-specific client extensions are available to notebooks by executing ONE of the following options:

    • For end users: (in the Anaconda console environment) build a conda package from the client extensions sources, then install it:

         conda build ${this-git-repo}/releng/iqs-jupyter-packaging/conda/incqueryserver-jupyter
         conda install --use-local incqueryserver-jupyter
    • For developers: issue the following command to perform a "developer" install directly from the source project; changes to the source will be reflected immediately to newly (re)started Python interpreters / Jupyter kernels (previously started kernels that already executed the import will keep the old content until restarted).

         conda develop ${this-git-repo}/source/incqueryserver-jupyter

Using pip instead of Conda

The above instructions mostly apply here as well. However, instead of issuing conda build and conda install on the conda recipe directories, run instead

pip install ${this-git-repo}/source/incqueryserver-jupyter

Specifying install -e will install these pip packages in "editable" mode, similarly to conda develop.

Additional dependencies

The demo notebook uses ploty and cufflinks to demonstrate possible applications of the client extensions package. It is not recommended to install cufflinks-py using conda, as conda-forge seems to host an obsolete version not compatible with the demo; simply issue pip install cufflinks from the Anaconda console instead.

Running the notebook

Set up environment variables first

Several functions and classes defined in client extension take optional arguments whose default values can be injected via environment variables. This allows the notebook itself to be much simpler, by omitting connection data etc.

Here is an example start-jupyter.cmd file you may wish to place into your notebook home, and use it to start jupyter with the right default values:

@echo off

set IQS_JUPYTER_default_IQS_address=
set IQS_JUPYTER_default_IQS_username=...
set IQS_JUPYTER_default_IQS_password=...

set IQS_JUPYTER_default_twc_workspace=4d6ce495-1273-452c-a548-36fcd922184e
set IQS_JUPYTER_default_twc_resource=34cc77c8-d3ef-40a6-9b91-65786117fe67
set IQS_JUPYTER_default_twc_branch=bd03a239-7836-4d4c-9bcb-eba73b001b1e
set IQS_JUPYTER_default_twc_revision=1

set IQS_JUPYTER_default_mms_org=6384a103-766c-46e0-830d-8a3b1f479479
set IQS_JUPYTER_default_mms_project=PROJECT-bef4f459-5d90-41fb-bc86-4f6d4ebd2dfd
set IQS_JUPYTER_default_mms_ref=master
set IQS_JUPYTER_default_mms_commit=560d3959-3912-434a-a914-8d039d3c9a06

set IQS_JUPYTER_default_twc_osmc_address=
set IQS_JUPYTER_default_twc_osmc_username=...
set IQS_JUPYTER_default_twc_osmc_password=...

jupyter notebook

Caution: beware of whitespace, make sure there is none before/after the =. A similar shell script can be used in case of *nix systems; a docker file might be another good way to provide environment variables.

Run the notebook

  1. (in the Anaconda console environment) start a Jupyter server from ${path-to-notebook-home}: jupyter notebook
  2. Interact with Jupyter either via the newly opened browser window, or using the URL or token printed by the Jupyter server to its stdout. Create a new notebook or open an existing one within the notebook folder; see an example in ${this-git-repo}/example-notebook-home/iqs-demo-twc.ipynb (if the parent folder is designated as notebook home, you should already see this notebook as a starting point).
  3. Within the notebook, get started by:
    1. Import the Jupyter-specific client library

        import iqs_jupyter
    2. Create a widget to specify an access point

        connector = iqs_jupyter.IQSConnectorWidget()
    3. Fill out the text field of the widget to specify the address to a running IQS server instance, then create the main client object iqs:

        iqs = connector.connect()
      • To skip manual form filling, it is possible to specify the initial content of the widget fields using a number of ways. First, IQSConnectorWidget has the optional parameters initial_address, initial_user, initial_password. Second, if such parameters are not given, results may be automatically filled from environment variables (see below). If such default values are known, it is possible to skip this step and the previous one by not displaying a widget at all:

            iqs = iqs_jupyter.connect()
    4. Browse for a TWC revision using

        revision_selector = iqs.jupyter_tools.twc_revision_selector_widget()
    5. Access the full JSON/RPC API of IQS in the form of (you may use TAB completion):

You can’t perform that action at this time.