contrib

Resources for projects contributing to WaterTAP

Updating the version of WaterTAP

The version of WaterTAP (or, more precisely, the watertap Python package distribution) is set in the setup.py file:

# in setup.py
setup(
    name="watertap-myproj",
    install_requires=[
        "watertap",
    ],
)

Without other specifiers, the latest stable release of WaterTAP will be used. However, several alternatives are possible:

    install_requires=[
-        "watertap",
+        "watertap @ https://github.com/watertap-org/watertap/archive/myref.zip",
    ],

where myref can be any valid Git ref available on the watertap-org/watertap repository:

• A branch name, e.g. main
• A tag, e.g. 0.7.0rc1
• A commit SHA (or part of it), e.g. 37d9be3

⚠️ IMPORTANT ⚠️ After any change made to setup.py, the installation command (typically pip install -r requirements-dev.txt) should be run again (after activating the Python/Conda environment used for development) to ensure that the watertap package distribution is re-installed according to the current specification.