Skip to main content

Q-CTRL Python Visualizer

Project description

python-visualizer

Provides visualization of data for Q-CTRL’s Python products.

Table of Contents

Installation

Q-CTRL Python Visualizer can be installed through pip or from source. We recommend the pip distribution to get the most recent stable release. If you want the latest features then install from source.

Requirements

To use Q-CTRL Python Visualizer you will need an installation of Python. We recommend using the Anaconda distribution of Python. Anaconda includes standard numerical and scientific Python packages which are optimally compiled for your machine. Follow the Anaconda Installation instructions and consult the Anaconda User guide to get started.

From PyPi

Use pip to install the latest version of Q-CTRL Python Visualizer.

pip install qctrl-visualizer

From Source

The source code is hosted on Github. The repository can be cloned using

git clone git@github.com:qctrl/python-visualizer.git

Once the clone is complete, you can run the install script.

cd python-visualizer
python setup.py develop

Note: We recommend installing using develop to point your installation at the source code in the directory where you cloned the repository.

To test your installation run pytest in the python-visualizer directory.

pytest

Contributing

For general guidelines, see Contributing.

Building documentation

Documentation generation relies on Sphinx. Automated builds are done by Read The Docs.

To build locally:

  1. Ensure you have used one of the install options above.

  2. Execute the make file from the docs directory:

    If using Poetry:

    cd docs
    poetry run make html
    

    If using setuptools:

    cd docs
    # Activate your virtual environment if required
    make html
    

The generated HTML will appear in the docs/_build/html directory.

Credits

See Contributors.

License

See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for qctrl-visualizer, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size qctrl_visualizer-1.3.0-py3-none-any.whl (12.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size qctrl-visualizer-1.3.0.tar.gz (12.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page