PySubsea#

Project Philosophy#

PySubsea is an open-source code for pipeline and riser design.

PySubsea is a personal project developed by Ismael Ripoll to consolidate and automate tasks frequently encountered in his daily engineering routine, with the aim of having them version-controlled and accessible through a structured repository.

The development and usage of PySubsea are strictly limited to personal, non-commercial use, with a focus on training, experimentation, and the structured compilation of knowledge. This project is maintained independently and does not relate to or interfere with Ismael’s professional responsibilities as an employee. It serves as a personal learning tool and a way to consolidate practical insights outside the scope of his employment.

The repository has been made publicly accessible to encourage collaboration and knowledge sharing among colleagues, while maintaining that all proprietary or confidential information remains excluded. It has been made available to allow colleagues to review, build upon, and make use of it in a collaborative and open manner, in the hope that this may give the repository a chance to continue improving beyond its original scope.

  • PySubsea has made available with the intend of allowing the community to review, expand and use it under a MIT License. The MIT license is one of the most permissive open-source licenses, allowing for reuse and modification with minimal restrictions.

  • Source code: The source code is saved in GitHub.

  • PyPi Wheel: A downloadable wheel of PySubsea is found in PyPi. To install PySubsea, execute pip install pysubsea in a command terminal.

Project Member#

The management of this open-source project is carried out by Ismael Ripoll, the project founder and current maintainer.

While PySubsea is currently a personal initiative led by Ismael Ripoll, the project is hosted under the dedicated PySubsea GitHub organisation rather than a personal account. Although there is no immediate intention to formally announce or release the project or expand the team, this structure has been adopted to maintain flexibility for any future developments and to facilitate transparent and manageable collaboration if it occurs.

How to Contribute to the Project#

Interested in contributing to this personal project?

  • If you have a contribution in mind, please add it in Discussions.

  • If you have identified an issue with the code, please add it in Issues.

PySubsea Python Library Versions#

THE REQUIREMENTS.txt file contains the libraries for which the script has been developed and shown to run.

If some of libraries imported by PySubsea lead to issues, before running PySubsea for first time, follow these steps to activate a virtual environment from the REQUIREMENTS.TXT file:

  1. Open a Command Prompt or PowerShell and navigate to the folder where PySubsea is cloned and copy REQUIREMENTS.txt file.

    $ cd path/to/py-subsea

  2. In the folder where the code that imports PySubsea is saved, to create the virtual environment, run:

    $ python -m venv env

  3. To activate the virtual environement, run: [This command works in the VSCode’s PowerShell. Command may vary in other shells]

    $ env/Scripts/Activate.ps1

  4. To install the necessary libraries, run:

    $ pip install -r ./REQUIREMENTS.txt

Afterwards, the virtual environement must be activated before running PySubsea by using the command in Step 3.

Contents#