Skip to content
Open
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
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,30 @@ pythonCWMS -m pip install package-name

Packages included in releases are defined by [base requirements](requirements/base_requirements.txt) and [supplemental requirements](requirements/supplemental_requirements.txt), then resolved into the hash-pinned [Windows lock](requirements/locked.txt).

## RTS and HEC-DSS scripts

Jython is still used as a launcher inside RTS and HEC-DSS. Edit `python_script_path` and `args` in [example_python_script_launcher.py](jython_scripts/example_python_script_launcher.py). Set `args` to `None` or an empty string when no arguments are needed; multiple arguments are split before launching CPython.
## HEC application scripts

Jython can launch external CPython processes from RTS or HEC-DSSVue. For RTS,
configure the `SCRIPTS` list in
[example_python_script_launcher.py](jython_scripts/example_python_script_launcher.py)
to provide a script menu, or use
[example_direct_python_script_launcher.py](jython_scripts/example_direct_python_script_launcher.py)
for a one-click RTS button. Both entry points support optional CDA credentials
and an optional snapshot of the active RTS forecast context. For scripts kept
with an RTS watershed, the examples use the recommended
`<watershed>\scripts\python` directory. These two launchers are RTS-specific
and do not run in HEC-DSSVue.

For HEC-DSSVue, use the separate
[DSSVue launcher](jython_scripts/example_dssvue_python_script_launcher.py).
It can launch a script from any configured directory, including a watershed's
`scripts\python` directory, but does not provide RTS authentication or forecast
context.

See the [RTS launcher guide](jython_scripts/README.md#rts-cpython-launcher) for
RTS configuration, child-process environment variables, security
considerations, and troubleshooting. See the
[DSSVue launcher guide](jython_scripts/README.md#hec-dssvue-cpython-launcher)
for standalone path and authentication guidance.

Do not use the former Jython `install_python.py` workflow to install Python CWMS. The file remains as a compatibility notice for old bookmarks, while the signed Windows installer is documented in the [Jython migration guide](jython_scripts/README.md). Saved copies of the old installer are also stopped by the retirement document at the root of `main`.

Expand Down
Loading
Loading