How to Use the Files in this Resource

This HydroShare resource contains presentation slides describing HydroServer's functionality along with example code for interacting with a HydroServer instance.

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 site 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 monitoring site to HydroServer using the hydroserverpy Python client package.
• HydroServer_Presentation.pptx: A PowerPoint presentation file containing the slides from the HydroServer overview presentation.
• HydroServer_Evaluation_Criteria.xlsx: An Excel spreadsheet containing the criteria used to evaluate HydroServer with specific notes about how HydroServer's functionality meets those criterai or not.

IMPORTANT NOTES ABOUT RUNNING THE NOTEBOOKS

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. The notebooks should also work with the CUAHSI HydroServer testing instance. To switch which instance you are using in the code, just change the URL.

Running the Code

Do the following to run the code in this resource:

1. Scroll to the top of this HydroShare resource and click the "Open With" button.
2. Click "CUAHSI JupyterHub". This will launch the CUAHSI JupyterHub instance with the code and data pre-loaded.
3. NOTE: 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).
4. After clicking on the "Open With" button, you will need to log in with HydroShare if you haven't already.
5. Select the first Python environment option under "Server Options".
6. Scroll to the bottom of the page and click "Start".
7. 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.

Alternatively, you can download the Jupyter Notebook files and run them locally in your Python environment. If you do that, place them all in the same folder along with the example CSV data file in this resource.