How to Use the Files in this Resource

This HydroShare resource contains example code for interacting with a HydroServer instance.

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 user account there.

Running the Code

There are two main options for using the code:

1. Scroll to the top of this resource and click the "Open With" button. There are two options for launching the code for execution:

2. Click "CIROH-2i2c JupyterHub". This will launch the CIROH-2i2c JupyterHub instance with the code and data pre-loaded. To use the CIROH 2i2c JupyterHub, you must first have an account to get access. Access the documentation at https://hub.ciroh.org/docs/services/cloudservices/2i2c/ to get an account.

3. Click "CUAHSI JupyterHub". This will launch the CUAHSI JupyterHub instance with the code and data pre-loaded. To use this option, you must have a HydroShare user account and be a member of the CUAHSI Cloud Computing Group in HydroShare (sign up at https://www.hydroshare.org/group/156). After clicking on the "Open With" button, 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.

4. Download the Jupyter Notebook files and run them locally in your Python environment.

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.
• 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.