Feature/forcing data

.github/workflows/build-release.yml

@@ -16,9 +16,9 @@ jobs:
       - name: Bump a new Release and update Version
         uses: actions/checkout@v2
         with:
-          fetch-depth: "0"
+          fetch-depth: '0'
       - name: Bump version and push tag
-        uses: anothrNick/github-tag-action@1.26.0
+        uses: anothrNick/github-tag-action@1.39.0
         id: update-tag
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,43 +1,47 @@
 # mcat-ras
+
 Contains the HEC-RAS model content and analysis tool (MCAT). Given a .prj file, this MCAT identifies paths to the plan, forcing, and geometry files and extracts the model's metadata and geospatial data.
 
 The MCAT includes:
+
 - a standard set of methods to evaluate a model's content:
-    - isamodel
-	- modeltype
-    - modelversion
-    - index
-    - isgeospatial
-	- geospatialdata
+  - isamodel
+  - modeltype
+  - modelversion
+  - index
+  - isgeospatial
+  - geospatialdata
+  - forcingdata
 - an API for executing the above methods.
 - a docker container for running the methods and API.
 
+## Contents
 
-## 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-RAS 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='******'
-    ```
+  ```
+  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>`
@@ -52,15 +56,14 @@ The following requests can be used to interrogate a model whose storage location
 
 `GET /geospatialdata?definition_file=<s3_key>`
 
+`GET /forcingdata?definition_file=<s3_key>`
 
-*For example: `http://mcat-ras:5600/isamodel?definition_file=models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj`*
-
+_For example: `http://mcat-ras:5600/isamodel?definition_file=models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj`_
 
 ### Swagger Documentation:
 
 ---
 
 To view docs goto: http://localhost:5600/swagger/index.html
 
-
-![](docs/swagger_image.png)
+![](docs/swagger_image.png)

handlers/forcingdata.go

@@ -0,0 +1,74 @@
+package handlers
+
+import (
+	"fmt"
+	"net/http"
+	"path/filepath"
+
+	"app/config"
+	"app/tools"
+
+	"github.com/USACE/filestore"
+	"github.com/go-errors/errors" // warning: replaces standard errors
+	"github.com/labstack/echo/v4"
+)
+
+// ForcingData godoc
+// @Summary Extract forcing data from flow files
+// @Description forcing data from a RAS model given an s3 key
+// @Tags MCAT
+// @Accept json
+// @Produce json
+// @Param definition_file query string true "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj"
+// @Success 200 {object} interface{}
+// @Failure 500 {object} SimpleResponse
+// @Router /forcingdata [get]
+func ForcingData(ac *config.APIConfig) echo.HandlerFunc {
+	return func(c echo.Context) error {
+
+		definitionFile := c.QueryParam("definition_file")
+		if definitionFile == "" {
+			return c.JSON(http.StatusBadRequest, "Missing query parameter: `definition_file`")
+		}
+
+		if !isAModel(ac.FileStore, definitionFile) {
+			return c.JSON(http.StatusBadRequest, definitionFile+" is not a valid RAS prj file.")
+		}
+
+		data, err := forcingData(definitionFile, ac.FileStore)
+		if err != nil {
+			return c.JSON(http.StatusInternalServerError, SimpleResponse{http.StatusInternalServerError, fmt.Sprintf("Go error encountered: %v", err.Error()), err.(*errors.Error).ErrorStack()})
+		}
+
+		return c.JSON(http.StatusOK, data)
+	}
+}
+
+func forcingData(definitionFile string, fs *filestore.FileStore) (tools.ForcingData, error) {
+	fd := tools.ForcingData{
+		Steady:   make(map[string]tools.SteadyData),
+		Unsteady: make(map[string]tools.UnsteadyData),
+	}
+
+	mfiles, err := modFiles(definitionFile, *fs)
+	if err != nil {
+		return fd, errors.Wrap(err, 0)
+	}
+
+	for _, fp := range mfiles {
+
+		ext := filepath.Ext(fp)
+
+		switch {
+
+		case tools.RasRE.AllFlow.MatchString(ext):
+
+			if err := tools.GetForcingData(&fd, *fs, fp); err != nil {
+				return fd, errors.Wrap(err, 0)
+			}
+
+		}
+	}
+
+	return fd, nil
+}

main.go

@@ -37,6 +37,7 @@ func main() {
 	e.GET("/index", handlers.Index(appConfig.FileStore))
 	e.GET("/isgeospatial", handlers.IsGeospatial(appConfig.FileStore))
 	e.GET("/geospatialdata", handlers.GeospatialData(appConfig))
+	e.GET("/forcingdata", handlers.ForcingData(appConfig))
 
 	// pgdb endpoints
 	e.POST("/upsert/model", pgdb.UpsertRasModel(appConfig, dbConfig))

tools/forcing.go

@@ -0,0 +1,41 @@
+// Structs and functions used to parse all [steady, unsteady, quasi-unsteady] types of flow files.
+
+package tools
+
+import (
+	"path/filepath"
+
+	"github.com/USACE/filestore"
+)
+
+// Main struct for focing data.
+type ForcingData struct {
+	Steady        map[string]SteadyData   `json:"Steady,omitempty"`
+	QuasiUnsteady map[string]interface{}  `json:"QuasiUnsteady,omitempty"` // to be implemented
+	Unsteady      map[string]UnsteadyData `json:"Unsteady,omitempty"`
+}
+
+// Boundary Condition.
+type BoundaryCondition struct {
+	RS          string      `json:",omitempty"`            // only exists for unsteady rivers
+	BCLine      string      `json:"bc_line,omitempty"`     // only exists for unsteady storage and 2D areas
+	Description string      `json:"description,omitempty"` // only exists for Rules, not implemented yet
+	Type        string      `json:"type"`
+	Data        interface{} `json:"data"`
+}
+
+// Get Forcing Data from steady, unsteady or quasi-steady flow file.
+func GetForcingData(fd *ForcingData, fs filestore.FileStore, flowFilePath string) (err error) {
+	extPrefix := filepath.Ext(flowFilePath)[0:2]
+
+	if extPrefix == ".f" {
+		err = getSteadyData(fd, fs, flowFilePath)
+	} else if extPrefix == ".u" {
+		err = getUnsteadyData(fd, fs, flowFilePath)
+	} else if extPrefix == ".q" {
+		flowFileName := filepath.Base(flowFilePath)
+		fd.QuasiUnsteady[flowFileName] = "Not Implemented"
+	}
+
+	return err
+}

tools/geospatial.go

@@ -7,7 +7,6 @@ import (
 	"math"
 	"path/filepath"
 	"regexp"
-	"strconv"
 	"strings"
 
 	"github.com/USACE/filestore"
@@ -64,54 +63,6 @@ func checkUnitConsistency(modelUnits string, sourceCRS string) error {
 	return errors.New("Unable to check unit consistency, could not identify the coordinate reference system's units")
 }
 
-func dataPairsfromTextBlock(sc *bufio.Scanner, nPairs int, colWidth int, valueWidth int) ([][2]float64, error) {
-	var stride int = valueWidth * 2
-	pairs := [][2]float64{}
-out:
-	for sc.Scan() {
-		line := sc.Text()
-		for s := 0; s < colWidth; {
-			if len(line) > s {
-				val1, err := parseFloat(strings.TrimSpace(line[s:s+valueWidth]), 64)
-				if err != nil {
-					return pairs, errors.Wrap(err, 0)
-				}
-				val2, err := parseFloat(strings.TrimSpace(line[s+valueWidth:s+stride]), 64)
-				if err != nil {
-					return pairs, errors.Wrap(err, 0)
-				}
-				pairs = append(pairs, [2]float64{val1, val2})
-				if len(pairs) == nPairs {
-					break out
-				}
-			} else {
-				break
-			}
-			s += stride
-		}
-	}
-	return pairs, nil
-}
-
-func getDataPairsfromTextBlock(nDataPairsLine string, sc *bufio.Scanner, colWidth int, valueWidth int) ([][2]float64, error) {
-	pairs := [][2]float64{}
-	for sc.Scan() {
-		line := sc.Text()
-		if strings.HasPrefix(line, nDataPairsLine) {
-			nPairs, err := strconv.Atoi(rightofEquals(line))
-			if err != nil {
-				return pairs, errors.Wrap(err, 0)
-			}
-			pairs, err = dataPairsfromTextBlock(sc, nPairs, colWidth, valueWidth)
-			if err != nil {
-				return pairs, errors.Wrap(err, 0)
-			}
-			break
-		}
-	}
-	return pairs, nil
-}
-
 // distance returns the distance along a straight line in euclidean space
 func distance(p0, p1 [2]float64) float64 {
 	result := math.Sqrt(math.Pow((p1[0]-p0[0]), 2) + math.Pow((p1[1]-p0[1]), 2))