Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@ pip install shef-parser

## Loading via command line
```sh
#CWMS CDA loader
#CWMS CDA loader will load for all offices
shefParser -i input_filename --loader cda[$API_ROOT][$API_KEY]
# optional office scoping for transform lookup
shefParser -i input_filename --loader cda[$API_ROOT][$API_KEY][MVP]
shefParser -i input_filename --loader cda[$API_ROOT][$API_KEY][MVP,LRL,SWG]
```

```sh
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "shef-parser"
repository = "https://github.com/HydrologicEngineeringCenter/SHEF_processing"

version = "1.10.0"
version = "1.11.0"


packages = [
Expand Down
7 changes: 4 additions & 3 deletions rtd_docs/using-cda-loader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ This page does not cover unloading with the ``--unload`` command line option, wh
Command Line
------------

To use the :py:`CdaLoader` class, specify ``--loader cda[<cda_url_root>][<cda_api_key>]`` on the command line, where
To use the :py:`CdaLoader` class, specify ``--loader cda[<cda_url_root>][<cda_api_key>][<office>]`` on the command line, where

* ``<cda_url_root>`` is the URL to the Cwms Data API (e.g., ``https://cwms-data-test.cwbi.us/cwms-data/`` for the CWBI test database)
* ``<cda_api_key>`` is your personal authentication key for the database referenced by the URL
* ``<office>`` is optional and can be a single office code (for example, ``MVP``) or a list of offices (for example, ``['MVP','LRL','SWG']`` or ``["MVP","LRL","SWG"]``)

It is recommended to use environment variables to hold the URL root and API key so that your command line would look
something like ``run_shef_parser --loader cda[%CDA_URL_ROOT%][%CDA_API_KEY%]`` on Windows or ``run_shef_parser --loader cda[$CDA_URL_ROOT][$CDA_API_KEY]``
on Linux
something like ``run_shef_parser --loader cda[%CDA_URL_ROOT%][%CDA_API_KEY%][MVP]`` on Windows or ``run_shef_parser --loader cda[$CDA_URL_ROOT][$CDA_API_KEY][MVP]``
on Linux. For multiple offices, use ``run_shef_parser --loader 'cda[$CDA_URL_ROOT][$CDA_API_KEY]["MVP","LRL","SWG"]'``.

Loading Configuration
----------------------
Expand Down
Loading
Loading