updated README.md

CI-WATER · Jul 3, 2015 · 00b5108 · 00b5108
1 parent f8e31e3
commit 00b5108
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -3,4 +3,11 @@ hydrogate_python_client
 
 Python client for *HydroDS* web based data and computational services.
 
-*NOTE:* Details on how to use this client api will be documented here soon.
+*NOTE:* Details on how to use this client api is documented within each of the client api functions. There is also
+        sample code under the ```/tests/non-hpc folder``` for each of the api functions.
+
+*Dependency:* Python 2.7 and Requests module
+
+*Access requirements:* In order to access HydroDS web services using this client, you need to have an user account
+                       on HydroDS. In order to create HydroShare resources using HydroDS web service, you will also
+                       need an account on HydroShare.
diff --git a/hydrogate.py b/hydrogate.py
@@ -2026,16 +2026,16 @@ def convert_netcdf_units(self, input_netcdf_url_path, output_netcdf, variable_na
         Example usage:
             hds = HydroDS(username=your_username, password=your_password)
             input_netcdf_url_path = 'http://hydro-ds.uwrl.usu.edu:20199/files/data/user_2/subset_netcdf_to_spawn.nc'
-            try:
-                response_data = hds.convert_netcdf_units(input_netcdf_url_path=input_netcdf_url_path,
-                                                         output_netcdf='converted_units_spwan.nc',
-                                                         variable_name='prcp', variable_new_units="m/hr",
-                                                         multiplier_factor=0.00004167, offset=0)
 
-                output_netcdf_url = response_data['output_netcdf']
+            response_data = hds.convert_netcdf_units(input_netcdf_url_path=input_netcdf_url_path,
+                                                     output_netcdf='converted_units_spwan.nc',
+                                                     variable_name='prcp', variable_new_units="m/hr",
+                                                     multiplier_factor=0.00004167, offset=0)
+
+            output_netcdf_url = response_data['output_netcdf']
 
-                # print the url path for the generated netcdf file
-                print(output_netcdf_url)
+            # print the url path for the generated netcdf file
+            print(output_netcdf_url)
         """
 
         if save_as: