CWMSTable Salinity Data unit

[snzhao-usace]

Component Issue

CWMSTable

Describe the bug

I use CWMSTable for our public site. For Conc-Salinity, it always returns with unit mg/l. We would like to display data in g/l. I checked CWBI-TEST, and it also returns data at g/l. Wonder why CWMSTable returns mg/l, and how it can be corrected. Below is script (jsx), and I also attach a screenshot:

  const tableTimeSeriesParams = [
    {
      tsid: "BBLW_S1-D11,0ft.Conc-Salinity.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Salinity @11.0ft<br /> (ppm)</>,
      precision: 2,
    },
    {
      tsid: "BBLW_S1-D21,0ft.Conc-Salinity.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Salinity @21.0ft<br /> (ppm)</>,
      precision: 2,
    },
    {
      tsid: "BBLW_S1-D32,0ft.Conc-Salinity.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Salinity @32.0ft<br /> (ppm)</>,
      precision: 2,
    },
    {
      tsid: "BBLW_S1-D5,0ft.Temp-Water.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Temp-Water <br />@5.0ft (F)</>,
      precision: 2,
    },
    {
      tsid: "BBLW_S1-D11,0ft.Temp-Water.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Temp-Water <br />@11.0ft (F)</>,
      precision: 2,
    },
    {
      tsid: "BBLW_S1-D21,0ft.Temp-Water.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Temp-Water <br />@21.0ft (F)</>,
      precision: 2,
    },
    {
      tsid: "BBLW_S1-D32,0ft.Temp-Water.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Temp-Water <br />@32.0ft (F)</>,
      precision: 2,
    },
  ];

   return (
    <UsaceBox title={stitle}>
      <div className="overflow-y-auto h-[60vh]">
        <CWMSTable
          begin={cdaParams.begin}
          end={cdaParams.end}
          office={cdaParams.office}
          timeseriesParams={tableTimeSeriesParams}
          interval="5"
          missingString="---"
          sortAscending={false}
          trim={true}
          pageSize={2000}
          cdaUrl={myCDAURL}
        />
      </div>
    </UsaceBox>
  );

REDACTED relevant log output

Steps to Reproduce

No response

[snzhao-usace]

Link: https://water.usace.army.mil/office/nws/data/lkw_bblw_table

[krowvin]

@snzhao-usace

The units available to CDA can be seen here:
https://cwms-data.usace.army.mil/cwms-data/units

i.e.

 {
    "abstract-parameter": "Mass Concentration",
    "name": "g/l",
    "long-name": "Grams per liter",
    "unit-system": "SI",
    "description": "Mass concentration of 1 gram per liter",
    "alternate-names": [
      "gm/l",
      "grams per liter",
      "grams/liter",
      "ppt",
      "PPT"
    ]
  },

and g/l does look like an option. To have your Time Series use this unit (and not the default of ppm) you should be able to try the following:

  const tableTimeSeriesParams = [
    {
      tsid: "BBLW_S1-D11,0ft.Conc-Salinity.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Salinity @11.0ft<br /> (g/l)</>,
      precision: 2,
      unit: "g/l"
    },
    ...
  ];

I found this via the Groundwork Water docs here in the cdaParams
https://usace-watermanagement.github.io/groundwork-water/#/docs/tables
(scroll down to cdaParams at the bottom)

and those pointed me to the cdaParams object reference:
https://hydrologicengineeringcenter.github.io/cwms-data-api-client-javascript/interfaces/GetTimeSeriesRequest.html

[snzhao-usace]

@krowvin

I tried and still got data in ppm, not g/l. Here is the updated script:

const cdaParams = {
    begin: dayjs(dateRange.start).format("YYYY-MM-DDTHH:mm:ssZZ"),
    end: dayjs(dateRange.end).format("YYYY-MM-DDTHH:mm:ssZZ"),
    office: "NWDP",
    unit: "SI",
    pageSize: pagesize
  }

  const tableTimeSeriesParams  = [
    {
      tsid: "BBLW_S1-D11,0ft.Conc-Salinity.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Salinity @11.0ft<br /> (ppm)</>,
      precision: 2,
      unit: "g/l",
    },
    {
      tsid: "BBLW_S1-D21,0ft.Conc-Salinity.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Salinity @21.0ft<br /> (ppm)</>,
      precision: 2,
      unit: "g/l",
    },
    {
      tsid: "BBLW_S1-D32,0ft.Conc-Salinity.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Salinity @32.0ft<br /> (ppm)</>,
      precision: 2,
      unit: "g/l",
    },
    {
      tsid: "BBLW_S1-D5,0ft.Temp-Water.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Temp-Water <br />@5.0ft (F)</>,
      precision: 2,
      unit: "DegF",
    },
    {
      tsid: "BBLW_S1-D11,0ft.Temp-Water.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Temp-Water <br />@11.0ft (F)</>,
      precision: 2,
      unit: "DegF",
    },
    {
      tsid: "BBLW_S1-D21,0ft.Temp-Water.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Temp-Water <br />@21.0ft (F)</>,
      precision: 2,
      unit: "DegF",
    },
    {
      tsid: "BBLW_S1-D32,0ft.Temp-Water.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Temp-Water <br />@32.0ft (F)</>,
      precision: 2,
      unit: "DegF",
    },
  ];

   <div className="overflow-y-auto h-[60vh]">
        <CWMSTable
          begin={cdaParams.begin}
          end={cdaParams.end}
          office={cdaParams.office}
          timeseriesParams={tableTimeSeriesParams}
          missingString="---"
          sortAscending={false}
          trim={true}
          pageSize={2000}
          cdaUrl={myCDAURL}
        />
      </div>

In groundwork-water doc, https://usace-watermanagement.github.io/groundwork-water/#/docs/tables, unit can be set in "cdaParams" for CWMSTable, and it is not in "timeseriesParams" although it doesn't complain.

Updated scripts are in cwbi-dev, https://water.dev.cwbi.us/office/nws/data/lkw_bblw_table.

Thanks a lot for your help.

[krowvin]

@snzhao-usace

Looks like I was wrong on the unit, should be "SI" and your cdaParams does not appear to pass in units in the CWMSTable component. only begin, end, office are passed in via the dot operator.

See if changing each of your tableTimeSeriesParams unit to be SI returns.

I was seeing mg/l on my end.

i.e.

{
      tsid: "BBLW_S1-D11,0ft.Conc-Salinity.Inst.1Hour.0.IRIDIUM-REV",
      header: <>Salinity @11.0ft<br /> (ppm)</>,
      precision: 2,
      unit: "SI",
    },

    ...etc

From https://cwms-data.usace.army.mil/cwms-data/swagger-ui

[snzhao-usace]

I made changes and still got salinity data at mg/l. I want to display values at g/l. Either it returns data at g/l (seems mg/l by default) or there is a way to let me divide by 1000. Thanks.

[krowvin]

I see two options we could go with here

1. Have this added to the database as a valid unit for retrieval (if it is not)

   • The API would still return whatever the valid default is, in this case it is mg/L. We would need to request a new default(?)
   • Optionally, we could request different units from the API. I foresee this not being approved as it has been stated no math will be done by the API?

2. Use Add CWMSPlot CDA parity support #269 and Modernize CWMSTable rendering #268 - this would allow you to query your own TS data (mg/L) and then multiply each value by a 1000 in your case, then feed it into the table. It puts the burden on the end-user.

@MikeNeilson @Enovotny

[MikeNeilson]

specifying the unit system will always use the default unit for that parameter.
If the user is logged in and their session is setup, that default can be change (though I'm not sure we quite have CDA setup to allow that).

if "g/l" is specified as the unit the data should come back that way. If not something is going wrong somewhere.