Setup#
This first step to the tutorial will ensure your system is set up to handle all the subsequent sections, with all software installed and all data downloaded as needed. The index provides some links you might want to examine before you start.
Important
The instructions below are specific to this tutorial, and are designed to ensure that you install exactly the same versions for which the tutorial was written so that the output shown will exactly match what you see yourself. If you are looking to install a HoloViz package for your own use, please consult each library’s website (linked from HoloViz) for detailed guidance. Typically, installing these packages simply involves conda install or pip install, e.g. conda install hvplot datashader.
Hint
If you are attending a live tutorial or workshop and have previously run through the tutorial, make sure to run these steps again shortly before the live session to ensure you have the same version of the tutorial that the presenter will use.
Getting set up#
Open a new terminal window: (e.g. Terminal on a Mac, Powershell on Windows, or XTerm on Linux)
Install pixi: If you don’t have the pixi package manager installed, you can follow the pixi docs to download and install it.
Download and navigate to the tutorial project:
Download the tutorial ZIP archive
unzip it
change to the unzipped
holoviz_tutorialdirectory.
Create and activate the tutorial environment:
pixi run setup
Launch Jupyter: Don’t be alarmed when the previous command or this one outputs many lines as it downloads and installs packages. Subsequent launches will be faster as the downloaded packages are cached.
pixi run jupyter-lab
Note: You can replace “lab” with “notebook” if you prefer the original Jupyter notebook interface.
Test HoloViz imports: After launching Jupyter, navigate to this notebook (
tutorial/00_Setup.ipynb) and run the following cell. This command is a quick check that your environment is set up correctly. You should see the HoloViews, Bokeh, and Matplotlib logos along with a success message likeAll specified packages are correctly installed.
import datashader, panel, hvplot, param, holoviews as hv # noqa
from package_checker import check_packages
hv.extension('bokeh', 'matplotlib')
packages = ['datashader', 'holoviews', 'panel', 'hvplot', 'param']
check_packages(packages)
All specified packages are correctly installed.
Check datasets: Finally, run the following cell to make sure the dataset exists and is readable.
from data_checker import check_data
data_path = '../data/earthquakes-projected.parq'
check_data(data_path)
Data exists and is readable!
If you see Data exists and is readable! and no error messages above, you should be good to go! Now that you are set up, you can continue with the rest of the tutorial sections.
Hint
If you are using an AI assistant while learning, building, or preparing to contribute to HoloViz, you should also consider installing holoviz-skills, which provides the AI tool with HoloViz-specific guidance. holoviz-skills is a curated set of instructions and references that helps AI tools produce more idiomatic HoloViz examples and advice across the ecosystem. The most relevant entry point for this tutorial is the developing-with-holoviz directory, which routes to the right guidance for hvplot, holoviews, panel, and param depending on what you are working on.
