Package: ansys-dynamicreporting-core
OverviewPyDynamicReporting is the Python client library for Ansys Dynamic Reporting,
previously documented asNexus. 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 issuesDocumentation for the latest stable release of PyDynamicReporting is hosted atPyDynamicReporting 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 alsoviewordownloadthe
PyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands
for using PyDynamicReporting.On thePyDynamicReporting Issuespage, you can create issues to report bugs and request new features. On theDiscussionspage on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.To reach the project support team, emailpyansys.core@ansys.com.InstallationThepydynamicreportingpackage supports Python 3.9 through 3.12 on
Windows and Linux. It is currently available on the PyPirepository.To install the package, simply runpip install ansys-dynamicreporting-coreAlternatively, the user can download the repository and locally build the
package. Two modes of installation are available:Developer installationUser installationThe code provided for both installation modes use avirtual environment.Developer installationTo clone and install thepydynamicreportingpackage 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 modeThe preceding code creates an “editable” installation that lets you develop and test
PyDynamicReporting at the same time.User installationTo build and create a production-like installation for use, run this code: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 importPre-commit setuppre-commitis a framework for managing and
maintaining multi-language pre-commit hooks.To install thepre-commitpackage into your Git hooks, run this command:pre-commit installpre-commitnow runs on every commit.Each time you clone a project, installing thepre-commitpackage
should always be the first thing that you do.If you want to manually run all pre-commit hooks on a repository, run
this command:pre-commit run --all-filesThe preceding command runs a bunch of formatters on your source files.To run an individual hook, obtain the hook ID from the project’s.pre-commit-config.yamlfile and then run this code,
where<hook_id>is the obtained ID:pre-commit run <hook_id>The first timepre-commitruns on a file, it automatically downloads,
installs, and runs the hook.Local GitHub ActionsTo run GitHub Actions on your local desktop (recommended), install theactpackage.To run a job, such as thedocsjob from theci_cd.ymlfile, use
this command, wheredocsis the job name:act -j docsDeploy and upload stepsmust alwaysbe ignored. If they are not ignored,
before running GitHub Actions locally, addif: ${{ !env.ACT }}to the
workflow step and commit this change if required.DependenciesTo use PyDynamicReporting, you must have a locally installed and licensed copy
of Ansys 2023 R2 or later.Basic usageThis code shows how to start the simplest PyDynamicReporting session:>>>importansys.dynamicreporting.coreasadr>>>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 acknowledgementsPyDynamicReporting 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 theAnsyswebsite.