How to Use the Files in this Resource

This HydroShare resource contains example code for interacting with a HydroServer instance. The code is contained in three example Jupyter Notebooks that you can either download and run or you can run using JupyterHub environments linked to HydroShare.

IMPORTANT NOTES

1. Run the Notebooks in Order: The Notebook files in this resource are designed to be run in order. Run Example 1 before you run Example 2 and 3.
2. Get a user account for HydroServer first: The Notebook files in this resource are intended for use with the Playground HydroServer instance https://playground.hydroserver.org. If you want to try them you, you should navigate to the Playground instance first and set up a HydroServer user account there.

Running the Code

There are three options for using the code in this HydroShare resource:

Option 1: Use the CIROH 2026 DevCon Workshop JupyterHub Server: To use the CIROH 2i2c JupyterHub, you will need the workshop password. Consult the instructions that were provided via email for workshop attendees.

• Scroll to the top of this resource and click the "Open With" button
• Click "CIROH-2i2c JupyterHub (Workshop)"
• This will launch the CIROH-2i2c DevCon 2026 Workshop JupyterHub instance with the code and data pre-loaded.
• Note that this workshop JupyterHub instance is not intended for long-term use and may not be available after the 2026 Devon Conference. The two options below will work in the longer term.

Option 2: Use the CUAHSI JupyterHub Server: If you did not attend the workshop or you want to run the notebooks after the workshop is complete, you can use the CUAHSI JupyterHub Server. This will launch the CUAHSI JupyterHub instance with the code and data pre-loaded. NOTE: To use this option, you must have a HydroShare user account (sign up at https://www.hydroshare.org) and be a member of the CUAHSI Cloud Computing Group in HydroShare (sign up at https://www.hydroshare.org/group/156).

• Scroll to the top of this resource and click the "Open With" button
• Click "CUAHSI JupyterHub". You will need to log in with HydroShare if you haven't already.
• Select the first option under "Server Options" and then scroll to the bottom of the page and click "Start". After a few moments your Jupyter Hub Server will activate, and you can double-click on the notebook files in the left column to execute them.
• This will launch the CUAHSI JupyterHub server with the code and data pre-loaded.
• The hydroserverpy Python package is not installed on this JupyterHub server, so you will have to run that line of code in the notebooks to install it prior to use.

Option 3: Download the files and run locally: If you don't want to use one of the JupyterHub environments, you can download the Jupyter Notebook files and run them locally in your Python environment. Just leave all of the files in the same folder when you run them. You will need to configure your Python environment to ensure that you have hydroserverpy, Pandas, Matplotlib, and Jupyter installed.

Resource Contents

The following files are included in this resource:

• Hydroserver_Example1.ipynb: This Jupyter Notebook file contains an example of how to load time series data for a monitoring station from a comma separate values (CSV) file into a datastream in HydroServer.
• Hydroserver_Example2.ipynb: This Jupyter Notebook file contains an example of how to query time series data and associated metadata from HydroServer using the hydroserverpy Python package.
• Hydroserver_Example3.ipynb: This Jupyter Notebook file contains an example of how to use the hydroserverpy Python client package to automate creation, display, and editing of metadata for objects in HydroServer's data model.
• HydroServer_Example4.ipynb: This Jupyter Notebook file demonstrates how to stream live sensor data into HydroServer using hydroserverpy or using HTTP POST requests through HydroServer's SensorThings API.
• BSF_CONF_BA_SourceID_1_QC_0_Year_2024: This is an example data file containing sensor data used in the first example notebook above to load data for a monitroing station to HydroServer using the hydroserverpy Python client package.
• Workshop_Slides.pptx: This is a PowerPoint presentation that contains the slides from the workshop.