respec / BASINS

BASINS source code development repository. For official releases see EPA:
https://www.epa.gov/exposure-assessment-models/basins
29 stars 16 forks source link

[BASINS][SARA TS Utility][HSPEXP+]Developing New Graph Specification Files for BASINS/SARA TS Utility/HSPEXP+ #9

Open mishranurag opened 7 years ago

mishranurag commented 7 years ago

As you know HSPEXP+ has a functionality to generate graphs automatically based on the specifications provided in a graph specification file (*.csv). Brian and I have used it in MPCA, Illinois River Watershed, Fort Benning, and Fort AP Hill projects. I have used it in BASINS/HSPF workshop as well. Based on my experience at the workshop and interacting with some clients, I learned that the graph specification file is not easy to understand, edit and reuse. It has a steep learning curve. However, clients do like this functionality (Dino, Chuck etc.).

To overcome these issues, I am proposing a new graph specification file format; BASINS Graph Specification File (*.bgrf). An example of that is attached. I have listed the Pros and Cons of this format below.

GraphSpecificationFileFormatForHSPEXPPlus.txt

Pros

  1. Simpler to read in a text editor and edit.
  2. Most specifications are optional. This means that the user can provide a bare minimum input. Also gives us the ability to add more options later without breaking the format.
  3. Specifications are provided in a similar way in additional graphing software like R, MATLAB
  4. Can be used by BASINS, SARA, HSPEXP+, or WinHSPF

Cons

  1. What to do with the current format?
  2. Need additional money to work on it (EPA, SARA, and may be MPCA have shown interest)

Please read through the attached file and let me know what you think.

mishranurag commented 7 years ago

Explore "xml" and "json" as options for graph specification files.

mishranurag commented 6 years ago

Graph specifications in JSON formats will be available with the next release of BASINS. Additional testing and feature addition may be needed.