ansys-dynamicreporting-core 0.10.3

Python interface to Ansys Dynamic Reporting

Overview

PyDynamicReporting is the Python client library for Ansys Dynamic Reporting, previously documented as Nexus. Ansys Dynamic Reporting is a service for pushing items of many types, including images, text, 3D scenes, and tables, into a database, where you can keep them organized and create dynamic reports from them. When you use PyDynamicReporting to connect to an instance of Ansys Dynamic Reporting, you have a Pythonic way of accessing all capabilities of Ansys Dynamic Reporting.

Documentation and issues

Documentation for the latest stable release of PyDynamicReporting is hosted at PyDynamicReporting documentation.

In the upper right corner of the documentation’s title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

You can also view or download the PyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands for using PyDynamicReporting.

On the PyDynamicReporting Issues page, you can create issues to report bugs and request new features. On the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email [e-mail].

Installation

The pydynamicreporting package supports Python 3.10 through 3.12 on Windows and Linux. It is currently available on the PyPi repository.

To install the package, simply run

pip install ansys-dynamicreporting-core

Developer installation

To clone and install the pydynamicreporting package in development mode, run this code:

git clone https://github.com/ansys/pydynamicreporting
cd pydynamicreporting
pip install virtualenv
virtualenv venv  # create virtual environment
source venv/bin/activate  # (.\venv\Scripts\activate for Windows shell)
make install-dev  # install pydynamicreporting in editable mode

The preceding code creates an “editable” installation that lets you develop and test PyDynamicReporting at the same time.

To build and create a production-like installation on Windows (not required on other OSes), first install chocolatey. Then:

choco install make  # install make on Windows
make clean  # clean
make build   # build
# this replaces the editable installation done previously. If you don't want to replace,
# switch your virtual environments to test the new install separately.
make install
# you can skip the steps above and just do 'make all'
make smoketest  # test import

Local GitHub Actions

To run GitHub Actions on your local desktop (recommended), install the act package.

choco install act-cli

To run a job, such as the style job from the ci_cd.yml file, use this command, where style is the job name:

act -W '.github/workflows/ci_cd.yml' -j style --bind

Deploy and upload steps must always be ignored. If they are not ignored, before running GitHub Actions locally, add if: ${{ !env.ACT }} to the workflow step and commit this change if required.

Local tests

To run tests on your local desktop (recommended), use the make target test-dev. This target runs the tests in the same way as GitHub Actions but using a local Ansys installation instead of Docker. You must specify the path to your Ansys installation and the test file you are trying to run.

make test-dev TEST_FILE="tests/test_service.py" INSTALL_PATH="C:\Program Files\ANSYS Inc\v252"

Note that any tests that require Docker will obviously fail.

Creating a Release

• Before creating a new branch, make sure your local repository is up to date:

  git pull

  This ensures you have the latest changes from the default branch (usually main or develop).

• Create a new branch for the release:

  git checkout -b release/0.10

  Important: The release branch must only include the major and minor version numbers. Do not include the patch version. For example, use release/0.10, not release/0.10.0.

• If creating a patch release, do not create a new branch. Instead, reuse the existing release/0.10 branch.

• Update the version number in pyproject.toml:

  If the current version is:

  version = "0.10.0.dev0"

  bump it to:

  version = "0.10.0"

• Important: Every time you create a development (dev) release, you should first release the corresponding stable version on PyPI before bumping the development version.

  For example:

  • If you are at 0.10.0.dev0, first release 0.10.0 on PyPI.

  • Then, after the release, bump the version to 0.10.1.dev0.

  Otherwise, it may feel confusing to have a dev version without a corresponding stable release.

• Create a commit for the version bump:

  git commit -am "MAINT: Bump version to v0.10.0"

• Then push the branch:

  git push --set-upstream origin release/0.10

• Create a tag for the release:

  git tag v0.10.0
  git push origin v0.10.0

  Important: The release tag must always include the full major.minor.patch version number. Always include the v prefix. For example, use v0.10.0, not v0.10. Creating and pushing the tag automatically triggers the release workflow in GitHub Actions.

Dependencies

To use PyDynamicReporting, you must have a locally installed and licensed copy of Ansys 2023 R2 or later.

To use PyDynamicReporting Serverless (ansys.dynamicreporting.core.serverless), you must have a locally installed and licensed copy of Ansys 2025 R1 or later.

Basic usage

This code shows how to start the simplest PyDynamicReporting session:

>>> import ansys.dynamicreporting.core as adr
>>> adr_service = adr.Service(ansys_installation=r"C:\Program Files\ANSYS Inc\v232")
>>> ret = adr_service.connect()
>>> my_img = adr_service.create_item()
>>> my_img.item_image = "image.png"
>>> adr_service.visualize_report()

License and acknowledgements

PyDynamicReporting is licensed under the MIT license.

PyDynamicReporting makes no commercial claim over Ansys whatsoever. This library extends the functionality of Ansys Dynamic Reporting by adding a Python interface to Ansys Dynamic Reporting without changing the core behavior or license of the original software. The use of PyDynamicReporting requires a legally licensed copy of an Ansys product that supports Ansys Dynamic Reporting.

To get a copy of Ansys, visit the Ansys website.