Install Libraries for Interacting with HydroShare

[Castronova]

In order to interact with HydroShare programmatically from HydroFrame computing instances, e.g. Jupyter notebooks, several libraries need to be installed on the system. Below are a description of these items as well as installation instructions.

Libraries

• hsclient : a python client for interacting with HydroShare

Installation Instructions

Installation is very straightforward since this library is hosted on pypi.org.

pip install hsclient

Testing and Usage

Documentation for hsclient can be found on

• GitHub - hsclient
• PyPI - hsclient
• hydroshare.github.io/hsclient

Example Jupyter Notebooks can be found at

• HydroShare - resource:7561aa12fd824ebb8edbee05af19b910

Here's a simple example to test that hsclient is installed correctly.

from hsclient import HydroShare

# authenticate with HydroShare account
hs = HydroShare()
hs.sign_in()

# download a resource from HydroShare
existing_resource = hs.resource('7561aa12fd824ebb8edbee05af19b910')