PySubsea

PySubsea is a package for the design of subsea pipelines and risers in Python.

It was initiated and is developed by Subsea Energies to consolidate and automate tasks frequently encountered in subsea engineering workflows, ensuring they remain version-controlled and accessible within a structured repository.

The project follows a corporate open-source approach focused on collaboration, experimentation, and the systematiccompilation of engineering knowledge. PySubsea is maintained independently from client-specific or confidentialwork; instead, it serves as a shared engineering tool that captures practical insights in an open and reusableframework.

The repository is publicly available to encourage collaboration and knowledge sharing across the subsea industry, while ensuring that all proprietary or conditential information is excluded. By making the project open, the wider community can review it, contribute to it, and build upon it, allowing the repository to continue improving beyond its original scope.

Useful project links:

• Documentation: https://py-subsea.github.io/py-subsea
• Source code: https://github.com/py-subsea/py-subsea
• Bug reports: https://github.com/py-subsea/py-subsea/issues

Installation

Install PySubsea with its required NumPy and SciPy dependencies:

python -m pip install pysubsea

For an editable installation from a local checkout:

python -m pip install -e .

Optional dependencies are available for running the examples and building the documentation:

python -m pip install -e ".[examples,docs]"

Versioning and documentation builds

Update only project.version in pyproject.toml when changing the release version. Package builds generate their metadata from it, and Sphinx reads it directly for the documentation version.

After installing the documentation dependencies, rebuild the HTML from the docs directory with .\make.bat html on Windows or make html on Unix. These commands clean the previous documentation output first, removing obsolete pages. The GitHub Pages workflow also performs a clean build.

Rebuild the package (or reinstall the editable checkout) to refresh generated package metadata after changing the version; do not edit PKG-INFO manually.