Prerequisites | Installation | Contributing | License | Getting help

QuantLab

An extensible computational environment for Jupyter.

QuantLab is a very early developer preview, and is not suitable for general usage yet. Features and implementation are subject to change.

Prerequisites

Jupyter notebook version 4.2 or later. To check the notebook version:

jupyter notebook --version

Supported Runtimes

The runtime versions which are currently known to work:

• Firefox 49+
• Chrome 39+
• Safari 10+

Earlier browser versions may also work, but come with no guarantees.

QuantLab uses CSS Variables for styling, which is one reason for the minimum versions listed above. IE 11+ or Edge 14 do not support CSS Variables, and are not directly supported at this time. A tool like postcss can be used to convert the CSS files in the quantlab/build directory manually if desired.

Installation

If you use conda, you can install as:

conda install -c conda-forge quantlab

If you use pip, you can install it as:

pip install quantlab
jupyter serverextension enable --py quantlab --sys-prefix

Start up QuantLab:

jupyter quantlab

QuantLab will open automatically in your browser. You may also access QuantLab by entering the notebook server's URL (http://localhost:8888) in the browser.

Instructions on how to install the project from the git sources are available in our contributor documentation.

Note: If installing using pip install --user, you must add the user-level bin directory to your PATH environment variable in order to launch jupyter quantlab.

Extensions

The QuantLab environment can be extended using extensions. See documentation for users and developers.

Contributing

If you would like to contribute to the project, please read our contributor documentation.

License

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

All code is licensed under the terms of the revised BSD license.

Getting help

We encourage you to ask questions on the mailing list, and you may participate in development discussions.

Resources

• Reporting Issues
• Architecture tutorial
• API Docs
• Documentation for Project Jupyter | PDF
• Project Jupyter website