Skip to content

Commit 8362558

Browse files
committed
update markdown
1 parent be4d8df commit 8362558

File tree

2 files changed

+21
-14
lines changed

2 files changed

+21
-14
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Python CWMS Portable Environment
2+
3+
A portable, Windows, Python environment bundled with CWMS libraries and dependencies.
4+
5+
## To Update Python Build
6+
7+
### Build Locally
8+
1. Clone this repository
9+
2. Optionally, modify WinPython variables (`WINPYTHON_VERSION`, `WINPYTHON_FILENAME`, and `WINPYTHON_DOWNLOAD_URL`) in the [release.yml](.github\workflows\release.yml) if upgrading python.
10+
3. Modify `requirements_binary_only.txt` with your dependencies
11+
4. Push a tag to trigger the build: `git tag v0.8` and `git push origin v0.8`
12+
13+
### Manual Build
14+
You can also trigger a build manually from the Actions tab.
15+
16+
## Requirements File
17+
18+
The `requirements_binary_only.txt` file contains all Python packages to be installed. Only binary wheels are used to ensure compatibility and faster installation.
19+

README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,18 +49,6 @@ Click `Install Portable Python` to install. Please be patient, it may take up to
4949
- 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.
5050
- Output of the python script will be passed to the CAVI console after the process is completed.
5151

52-
## To Update Python Build
53-
54-
### Build Locally
55-
1. Clone this repository
56-
2. Optionally, modify WinPython variables (`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`
59-
60-
### Manual Build
61-
You can also trigger a build manually from the Actions tab.
62-
63-
## Requirements File
64-
65-
The `requirements_binary_only.txt` file contains all Python packages to be installed. Only binary wheels are used to ensure compatibility and faster installation.
52+
## To help maintain the python builds
6653

54+
See [`CONTRIBUTING.md`](CONTRIBUTING.md)

0 commit comments

Comments
 (0)