Contribute

Overall guidance on contributing to a PyAnsys library appears in the Contributing topic in the PyAnsys Developer’s Guide. Ensure that you are thoroughly familiar with this guide before attempting to contribute to PyResultExplorer.

The following contribution information is specific to PyResultExplorer.

Install in developer mode

Installing PyResultExplorer in developer mode allows you to modify the source and enhance it.

1. Start by cloning this repository:

   git clone https://github.com/ansys/pyresultexplorer
   

2. Create a fresh-clean Python environment and activate it, uv is recommended for this purpose:

   # Create a virtual environment
   uv venv
   
   # Activate it in a POSIX system
   source .venv/bin/activate
   
   # Activate it in Windows CMD environment
   .venv\Scripts\activate.bat
   
   # Activate it in Windows Powershell
   .venv\Scripts\Activate.ps1
   

3. Install the library with its dependencies:

   uv sync --all-groups
   

4. Install pre-commit hooks to automatically check code style before committing:

   pre-commit install
   

How to test

To run the tests, you must have Result Explorer installed on your machine. Navigate to the root directory of the repository and run pytest. You can specify additional options to control the test execution, for example:

# Full test suite, running against a native instance of Result Explorer
pytest tests --launch-native

# Filter by file, additional verbosity, and show print statements
pytest -vv -s tests\test_launcher.py --launch-native

# Show browser window for visual feedback
pytest tests --launch-native --headed

# To run against an already running instance
pytest tests --connection-token=<token>

Tip

To interactively debug tests in Visual Studio Code, you may need to turn off the install_browser fixture, as it may interfere with the debugger.

Documentation

To build the documentation locally, navigate to the docs directory and run this command:

# On Linux or macOS
make html

# On Windows
./make.bat html

You can set the environment variable PYRX_DOC_SKIP_GALLERY to 1 to skip building the gallery examples, which can take a long time to build.

Note that to build the documentation examples you must have Result Explorer installed on your machine.