Postman collection#

For reference and documentation of the API, please open the postman collection for the version of ripple1d

v0.7.0: This beta version contains:
new endpoints:

  • create_rating_curves_db: creates rating curve using results from run_known_wse and run_incremental_normal_depth results

  • jobs: added endpoints to view job results, metadata, and logs

new args:

  • write_depth_grids (bool) added to run_known_wse and run_incremental_normal_depth endpoints

v0.6.0-v0.6.3: This beta version contains new args for the create_fim_lib endpoint:

  • library_directory: Specifies the output directory for the FIM grids and database.

  • cleanup: Boolean indicating if the ras HEC-RAS output grids should be deleted or not.

v0.5.0: This beta version contains new endpoints:

  • geom_to_gpkg: Extract the data from a model source dirctory to a gepoackage.

  • conflate: Conflate all reaches from the NWM network corresponding to the source model.

  • conflation_metrics: Apply conflation metrics for a conflated source model.

v0.4.1-v0.4.2: This beta version contains the endpoints included in the first production testing release. Note that the following variables should be set in the postman environment

postman variables:

- key: url
  value: localhost
  type: string
  description: The url of the ripple1d API

- key: source_model_directory
  value: "~\\repos\\ripple1d\\tests\\ras-data\\Baxter"
  type: string
  description: The source model directory (this needs to point to local directory where the source HEC-RAS model is stored)

- key: submodels_base_directory
  value: "~\\repos\\ripple1d\\tests\\ras-data\\Baxter\\submodels"
  type: string
  description: The base directory for the submodels (this needs to point to local directory where submodels generated by ripple1d are stored)

- key: nwm_reach_id
  value: '2823932'
  type: string
  description: The NWM reach id for the model (the default value included is for the Baxter model)

- key: jobID
  value: ''
  type: string
  description: The job id for the model run (this value is generated by the API)

v0.3.11: This version contains the first experimental endpoints included in the ripple1d API.

Show Source