Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.16 KB

README.md

File metadata and controls

69 lines (46 loc) · 2.16 KB
Raw

mcat-hms

CI Pipeline E2E Tests

Contains the HEC-HMS model content and analysis tool (MCAT). Given a .hms file, this MCAT identifies paths to .control, .met, .basin, .grid, .dss, .sqlite, and .shp files and extracts the model's metadata.

The MCAT includes:

  • a standard set of methods to evaluate a model's content:
    • isamodel
    • modeltype
      • modelversion
      • index
      • isgeospatial
      • geospatialdata
  • an API for executing the above methods.
  • a docker container for running the methods and API.

Contents

  • /config: contains the data structure that holds the config information for the API.
  • /docs: contains the auto-generated swagger files.
  • /handlers: contains the handler function for each API endpoint.
  • /tools: the core code used to extract information from the various HEC-HMS files.
  • docker-compose.yml: options for building the dockerfile.
  • main.go : API Server.

Getting Started

  • Add a .env file to the root level of this directory with the following structure: 
    AWS_ACCESS_KEY_ID='**************'
AWS_SECRET_ACCESS_KEY='**************'
AWS_DEFAULT_REGION='us-east-1'
S3_BUCKET='******'
  • Run docker-compose up
  • To teardown, run docker-compose down

MCAT REST Specification

The following requests can be used to interrogate a model whose storage location is defined by the s3_key parameter:

GET /isamodel?definition_file=<s3_key>

GET /modeltype?definition_file=<s3_key>

GET /modelversion?definition_file=<s3_key>

GET /index?definition_file=<s3_key>

GET /isgeospatial?definition_file=<s3_key>

GET /geospatialdata?definition_file=<s3_key>

For example: http://mcat-hms:5900/isamodel?definition_file=models/hms/Truckee_River/Truckee_River.hms

Swagger Documentation:

To view docs goto: http://localhost:5900/swagger/index.html