Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 1.78 KB

README.md

File metadata and controls

78 lines (61 loc) · 1.78 KB
Raw

About The Project

The pyvistool library is a Python package to create various visualizations offered by the VisTool of the Complexity Science Hub Vienna directly from your Python script.

Getting Started

To get a local copy up and running follow these simple steps.

Installation

  1. Clone the repository 
    git clone https://github.com/complexity-science-hub/pyvistool
  2. Change to the repository directory 
    cd pyvistool
  3. Build the package 
    python setup.py build
  4. Install the package 
    python setup.py install

Usage

To use the package, import it to your python script.

 from pyvistool import Vistool

You can find a list of available visualization and information about how to configure them here:

Create a configuration for the visualization you want to use:

    config = {
        "datasets": {
            "nameOfDataset": {
                "options": {
                    ...
                },
                "data": {
                    ...
                }
            }
        },
        "settings": {
            ...
        }
    }

Create and show the visualization (replace the appId):

    vt = Vistool(appId, config)
    vt.show()

Contact

Johannes Sorger - [email protected]
Wolfgang Knecht - [email protected]

Project Link: https://github.com/complexity-science-hub/pyvistool