User Guide¶

Most of the functionality developed in the EarthSim project is in the various general-purpose open-source Python packages like Bokeh, HoloViews, and Datashader. This User Guide focuses on documenting the small amount of code that’s actually in earthsim itself.

So far, what is documented here shows how to use the drawing/annotation tools that were added to Bokeh and HoloViews as part of this project, along with the specific application of those tools to specifying the generation of irregular triangular meshes used for variable-resolution simulations.

There is also some support in the earthsim module for running the GSSHA hydrology simulator, which is currently illustrated in the separate Topics section. Note that GSSHA and the Filigree and libfiligree packages used in the meshes section below are freely available but currently closed source; the rest of the packages used in EarthSim are all open source.

Drawing/annotation tools:

• Drawing Tools: Introduction to the drawing tools used to draw, edit and annotate data.
• Adding Annotations: Introduces a number of classes useful for annotating point, line and polygon data.

Making and using triangular meshes:

• Generating meshes with XMSMesh: Using draw tools to generate inputs to the XMSMesh mesh generator.
• Visualizing meshes: Demonstrates how to load large static and time-varying trimesh data and using datashader to interpolate it.
• Analyzing Meshes: Analyzing meshes by plotting data across multi-segment line cross-sections.