CalSim Toolkit Python Module

Summary

This library is intended for interaction with CalSim studies and related data. A modeler is able to run CalSim with Python commands, query data from DSS files, and call standard pre-/post-processing functions.

Acronyms

Abbreviation	Name
DSS	Data Storage System
DWR	State of California Department of Water Resources
HEC	U.S. Army Corps of Engineers' Hydrologic Engineering Center
USBR	U.S. Department of the Interior, Bureau of Reclamation

Tutorial

Follow the Jupyter Notebook in exploration/tutorial_00.ipynb for information regarding typical usage.

Dependencies

This module relies on the usbr_py3dss for reading from and writing data to DSS files. This module also utilizes Python objects in many popular third party libraries that ship with Anaconda for Python, such as pandas, numpy, and matplotlib.

Contact Information

This tool is maintained by USBR in Sacramento, CA. Contact Jim Shannon at [email protected].

Future Development

Future development tasks will focus on the following priorities:

1. Add read/write capabilities with HDF5 files formatted for CalSim studies;
2. Add pyhecdss as an alternative underlying dependency.
3. Write data to excel spreadsheets for use in many existing post-processing tools;
4. Apply data filtering by DWR Water Year Type;
5. Develop plot types saved for future use;
6. Include post-processing techniques representing USBR interests;
7. Update variable_dependencies application to output pandas DataFrame;
8. Expand documentation;
9. Draw plots with plotly.