Skip to content

Commit 58a459d

Browse files
committed
update readme
1 parent 76d3b9a commit 58a459d

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,19 @@ Click `Install Portable Python` to install. Please be patient, it may take up to
4343
#### Install additional libraries
4444
- To install additional libraries beyond what is in the [requirements_binary_only.txt](./requirements_binary_only.txt) file, open the WinPython powershell included in your python (e.g. `C:\hec\python\pythonCWMS0.8.0\WinPython Powershell Prompt.exe`) and do a pip install from there.
4545

46-
### CAVI Usage
47-
- To run a python script in the CAVI, edit the [`example_python_script_launcher.py`](./jython_scripts/example_python_script_launcher.py) jython script to point to your python script and save in the script editor. You can pass arguments from your jython environment (e.g. watershed path etc...).
46+
### CAVI Python Script Usage
47+
To use the python environment in the CAVI, a jython launcher script is used to run the python script as a subprocess. The jython script can also pass arguments to the python script.
4848

49-
## Python Build Development
49+
- To run a python script in the CAVI, edit the `python_script_path` and `args` variables in the [`example_python_script_launcher.py`](./jython_scripts/example_python_script_launcher.py) jython script to point to your python script and save in the CAVI script editor. You can pass arguments from your jython environment (e.g. watershed path etc...), but this is optional. Leave `args` as `None` or `''` if arguments are not needed.
50+
- Output of the python script will be passed to the CAVI console after the process is completed.
5051

51-
### Building Locally
52+
## To Update Python Build
53+
54+
### Build Locally
5255
1. Clone this repository
53-
2. Create/modify `requirements_binary_only.txt` with your dependencies
54-
3. Push a tag to trigger the build: `git tag v0.8 && git push origin v0.8`
56+
2. Optionally, modify WinPython varibles (`WINPYTHON_VERSION`, `WINPYTHON_FILENAME`, and `WINPYTHON_DOWNLOAD_URL`) in the [release.yml](.github\workflows\release.yml) if upgrading python.
57+
3. Modify `requirements_binary_only.txt` with your dependencies
58+
4. Push a tag to trigger the build: `git tag v0.8` and `git push origin v0.8`
5559

5660
### Manual Build
5761
You can also trigger a build manually from the Actions tab.

0 commit comments

Comments
 (0)