Documentation and Examples

Just getting started with VeRoViz? These links may be helpful:


VeRoViz Documentation

Detailed Function Reference Guide - Each VeRoViz function is fully documented, along with information on data providers, Leaflet/Cesium configuration options, and dataframe structures. Examples are also typically provided for each function.

On Jan. 14, 2021, we moved the Jupyter notebooks below to our GitHub repo. These were previously available here in .html format, but things weren't rendering properly.

Examples

"Journal Article" Jupyter Notebook (view on github | download .ipynb)

uploaded December 30, 2020

This notebook accompanies a journal article about VeRoViz. This article is currently under review, but you may read the manuscript in the meantime.

"New in Version 0.4.3" Jupyter Notebook (view on github | download .ipynb)

uploaded December 30, 2020

This notebook highlights the new features available in version 0.4.3.

"Function Examples" Jupyter Notebook (view on github | download .ipynb)

updated December 30, 2020

This notebook contains all of the examples described in the VeRoViz function documentation. Updated for version 0.4.3.

"New in Version 0.4.0" Jupyter Notebook (view on github | download .ipynb)

uploaded April 30, 2020

This notebook highlights the new features available in version 0.4.0.

"Cesium Demo" Jupyter Notebook (view on github | download .ipynb)

updated October 23, 2020

This notebook provides code for generating the Cesium demo that is included in the VeRoViz Cesium Viewer plugin. Updated for version 0.4.2.

"Show Cesium Models" Jupyter Notebook (view on github | download .ipynb)

updated October 23, 2020

This notebook provides code to display in Cesium all of the standard 3D models that ship with the VeRoViz Cesium Viewer plugin. Updated for version 0.4.2.

"INFORMS 2019 Talk" Jupyter Notebook (view on github | download .ipynb)

uploaded October 16, 2019

This notebook was used to generate the content for our 2019 INFORMS Annual Meeting talk.

"Homepage Demo" Jupyter Notebook (view on github | download .ipynb)

uploaded October 16, 2019

This notebook was created to support the basic example that is showcased on the VeRoViz homepage. The goal is to demonstrate a common workflow (create nodes, calculate distances, solve problem, visualize solutions) via a simple example.

"Getting Started Twitter Examples" Jupyter Notebook (view on github | download .ipynb)

uploaded October 18, 2019

This notebook was created for a Twitter thread on getting started with VeRoViz.

GitHub Repository

Github Source Code - VeRoViz is open-source. The GitHub repository contains all of the source code.