Contribute

Overall guidance on contributing to a PyAnsys repository appears in Contribute in the PyAnsys Developer’s Guide. Ensure that you are thoroughly familiar with this guide, paying particular attention to Guidelines and Best Practices, before attempting to contribute to PySeascape.

The following contribution information is specific to PySeascape.

Clone the repository

To clone and install the latest version of PySeascape in development mode, run:

git clone https://github.com/ansys/pyseascape
cd pyseascape
python -m pip install --upgrade pip
pip install -e .

Post issues

Use the PySeascape Issues page to submit questions, report bugs, and request new features.

To reach the support team, email pyansys.support@ansys.com.

View PySeascape documentation

Documentation for the latest stable release of PySeascape is hosted at PySeascape Documentation.

Documentation for the latest development version, which tracks the main branch, is hosted at Development PySeascape Documentation. This version is automatically kept up to date via GitHub actions.

Adhere to code style

PySeascape is compliant with PyAnsys code style. It uses the tool pre-commit to check the code style. You can install and activate this tool with:

pip install pre-commit
pre-commit run --all-files

You can also install this as a pre-commit hook with:

pre-commit install

This way, it’s not possible for you to push code that fails the style checks. For example:

$ pre-commit install
$ git commit -am "Add my cool feature."
black....................................................................Passed
blacken-docs.............................................................Passed
isort....................................................................Passed
flake8...................................................................Passed
codespell................................................................Passed
check for merge conflicts................................................Passed
debug statements (python)................................................Passed
Validate GitHub Workflows................................................Passed