Section 1. Installing PyGraphistry


There are 3 easy ways to get up and running quickly

Option 1:

Use your Graphistry server


Graphistry comes with Jupyter preinstalled, and preconfigured for Graphistry, PyGraphistry, Pandas, RAPIDS, and related libraries.

Option 2:


Direct install from Python's pip

ackage manager: Great for existing Python or Jupyter Notebook users

Depends on
Python 3.6+.


1. If you already have Python, install Jupyter:

pip install "jupyter"

2. Launch notebook server:

jupyter notebook

3. Install PyGraphistry:


pip install graphistry

Option 3:


Install from a premade Docker container with PyGraphistry, Jupyter Notebook,
and Scipy/numpy/pandas


1. Install Docker

2. Install and run the Jupyter Notebook + Graphistry container:

docker run -it --rm -p 8888:8888 graphistry/jupyter-notebook

If you would like to open data in the current folder $PWD or save results to the current folder $PWD, instead run:


docker run -it --rm -p 8888:8888 -v "$PWD":/home/jovyan/work/myPWDFolder graphistry/jupyter-notebook

3. After you run the above command, you will be provided a link. Go to it in a web browser:

http://localhost:8888/?token=< generated token value >

API Credentials


API credentials enable uploading visualizations to your server. Please ask your adminstrator or email info@graphistry.com. Set your key after the import graphistry statement and you are good to go:


import graphistry
graphistry.register(api=3, username='..', password='...') #session expires after 1hr
graphistry.register(api=3, token='...') #tokens expire 1hr after generation

Optionally, for convenience, you may set your API key in your system environment and thereby skip the register step in all your notebooks. In your .profile or .bash_profile, add the following, reload your environment, and restart your notebook server:


export GRAPHISTRY_API_KEY="Your key"

Server location


Specify where to upload your visualizations:


import graphistry
graphistry.register(protocol='https', server='hub.graphistry.com') graphistry.register(protocol='http', server='your.server.com:80')

Next: Visualizing Existing Graphs