Release notes#

This document contains the release notes for the project.

0.11.1 - 2024-06-21

Added#

  • FEAT: Add an App method to print project tree for embedding scenario #779

Changed#

  • Test specific version #771

  • chore: update CHANGELOG for v0.11.0 #777

  • chore: bump add-license-headers version to 0.3.2 #782

Fixed#

  • fix sharing app instances, clarify contract #784

0.11.0 - 2024-06-18#

Added#

  • feat: raise an exception if port or input script aren’t provided in batch mode #753

  • feat: use changelog.rst instead of CHANGELOG.md for release notes #757

  • Doc: Add embedding api references #758

  • feat: implement autoapi #761

Changed#

  • chore: update CHANGELOG for v0.10.11 #749

  • MAINT: Delete the apt-get lists after installing packages #750

  • [pre-commit.ci] pre-commit autoupdate #774

Fixed#

  • FIX: Modify pre-commit hook #763

  • fix lifetime issue #768

  • fix pythonnet issue #772

  • Fix: Remove disable sec check #776

Dependencies#

  • MAINT: Bump the doc group with 4 updates #751

  • [pre-commit.ci] pre-commit autoupdate #752

  • MAINT: Bump the doc group with 3 updates #755

  • MAINT: Update files as per pyansys standards #762

  • MAINT: Bump grpcio from 1.64.0 to 1.64.1 in the core group #764

  • MAINT: Bump pytest from 8.2.1 to 8.2.2 in the tests group #765

  • MAINT: Bump the doc group with 2 updates #766

Miscellaneous#

  • add method to update globals #767

0.10.11 - 2024-05-23#

Added#

  • feat: Add tests for animation exports #729

  • add feature flags to ansys-mechanical cli #735

  • feat: Add test for deprecation warning #739

Changed#

  • chore: update CHANGELOG for v0.10.10 #716

  • Maint: Display image info #717

  • [pre-commit.ci] pre-commit autoupdate #726

  • set mono trace env vars before loading mono #734

Fixed#

  • fix: merging coverage step in ci_cd #720

  • fix: Publish coverage for remote connect #721

  • fix: Restrict protobuf <6 #722

  • Fix: add return for poster #727

  • fix: cli test are not getting coverage #737

  • fix: adding mechanical libraries #740

  • feat: Add more coverage on logging #744

  • fix: Display image and build info only for scheduled run #746

  • fix: upload coverage files only for latest stable version on release workflow #748

Dependencies#

  • MAINT: Bump pytest from 8.1.1 to 8.2.0 in the tests group #724

  • MAINT: Bump the doc group with 3 updates #725, #743

  • MAINT: Bump grpcio from 1.62.2 to 1.63.0 in the core group #731

  • MAINT: Bump the doc group with 2 updates #732

  • MAINT: Bump grpcio from 1.63.0 to 1.64.0 in the core group #741

  • MAINT: Bump pytest from 8.2.0 to 8.2.1 in the tests group #742

Miscellaneous#

  • Split pyvista into two methods and remove the stability workaround for 242 #718

  • Update conf.py #723

  • catch the mono version warning #733

0.10.10 - 2024-04-23#

Added#

  • Add embedding_scripts marker #662

  • FEAT: Group dependabot alerts #666

  • add windows library loader util #672

  • Feat: Add reports for remote connect tests #690

  • Feat: Add link check #693

  • Feat: Add app libraries test #696

  • Feat: Update get_mechanical_path #707

  • Feat: mechanical-env check before running embedding #708

  • feat: set up doc-deploy-changelog action #710

Changed#

  • Doc: fix docs and vale warning #656

  • Maint: post release change log update 10.9 #665

  • Maint: Auto approve and merge dependabot PR #674

  • [pre-commit.ci] pre-commit autoupdate #691, #706

  • Maint: Add code cov report #692

  • Maint: Modify nightly run #712

Fixed#

  • Fix: Assign ci bot for dependabot PR #677

  • Fix: Add matrix python in embedding test #681

  • Fix: Remove warning message test for remote session launch #682

  • fix transformation matrix #683

  • Fix: Modify retrieving path of Mechanical in tests #688

  • work around instability in 2024R1 #695

Dependencies#

  • MAINT: Bump the doc group with 2 updates #668, #673

  • MAINT: Bump the doc group with 1 update #678

  • first version of 3d visualization with pyvista #680

  • MAINT: Bump the doc group with 3 updates #689

  • add open-usd exporter #701

  • MAINT: Bump the doc group with 5 updates #705, #715

  • MAINT: Bump grpcio from 1.62.1 to 1.62.2 in the core group #713

  • MAINT: Bump ansys/actions from 5 to 6 #714

Miscellaneous#

  • cleanup #702

  • update graphics based on backend changes #711

0.10.9 - 2024-03-27#

Added#

  • Block 32 bit python for embedding #647

  • Add usage of cli under embedding #650

  • Add changelog action #653

Fixed#

  • Fixed make pdf action in doc build #652

  • Use _run for better i/o in tests #655

  • Fix pdf action #664

Dependencies#

  • Bump pytest-cov from 4.1.0 to 5.0.0 #657

  • Bump ansys-mechanical-env from 0.1.4 to 0.1.5 #658

Miscellaneous#

  • DOC: Improve documentation for the embedded instances. #663

0.10.8 - 2024-03-18#

Added#

  • Add poster (#642)

  • Add LS Dyna unit test (#584)

Fixed#

  • Add logo for dark theme (#601)

  • Architecture doc (#612)

  • Put remote example before embedding example (#621)

  • Minor updates to Architecture doc (#618)

  • Add MechanicalEnums (#626)

  • Update Release action to use Stable version of Mechanical (#628)

  • Update nightly run image version (#636)

  • Update logo without slash (#640)

Changed#

  • Update pre-commit (#610)

  • Update vale version to 3.1.0 (#613)

  • Update timeout for actions (#631)

  • Update cheat sheet with ansys-sphinx-theme (#638)

Dependencies#

  • Bump ansys-sphinx-theme from 0.13.4 to 0.14.0 (#608)

  • Bump plotly from 5.18.0 to 5.20.0 (#605, #644)

  • Bump pypandoc from 1.12 to 1.13 (#609)

  • Bump pytest from 8.0.0 to 8.1.1 (#606, #623, #634)

  • Bump grpcio from 1.60.1 to 1.62.1 (#620, #635)

  • Bump pandas from 2.2.0 to 2.2.1 (#619)

  • Bump matplotlib from 3.8.2 to 3.8.3 (#607)

  • Bump ansys-mechanical-env from 0.1.3 to 0.1.4 (#624)

  • Bump pyvista from 0.43.3 to 0.43.4 (#643)

0.10.7 - 2024-02-13#

Added#

  • Upload 241 docker files (#567)

  • Add pre-commit hooks (#575)

  • Add Automatic version update for Mechanical scripting external links (#585)

  • Add PyMechanical logo (#592)

Changed#

  • Update getting started page (#561)

  • Update 232 to 241 in docs, docstrings, examples, and tests (#566)

  • Update workflow versions to run 241 and 242 (#590)

Dependencies#

  • Bump pyvista from 0.43.1 to 0.43.3 (#564, #598)

  • Bump sphinxcontrib-websupport from 1.2.6 to 1.2.7 (#562)

  • Bump ansys-sphinx-theme from 0.13.0 to 0.13.4 (#563, #586, #596)

  • Bump pandas from 2.1.4 to 2.2.0 (#571)

  • Bump sphinxemoji from 0.2.0 to 0.3.1 (#569)

  • Bump tj-actions/changed-files from 41 to 42 (#572)

  • Bump panel from 1.3.6 to 1.3.8 (#570, #579)

  • Bump peter-evans/create-or-update-comment from 3 to 4 (#576)

  • Bump pytest from 7.4.4 to 8.0.0 (#577)

  • Bump sphinx-autodoc-typehints from 1.25.2 to 2.0.0 (#578, #597)

  • Update pre-commit (#580, #599)

  • Bump ansys.mechanical.env from 0.1.2 to 0.1.3 (#583)

  • Bump sphinx-autobuild from 2021.3.14 to 2024.2.4 (#588)

  • Bump pytest-sphinx from 0.5.0 to 0.6.0 (#587)

  • Bump grpcio from 1.60.0 to 1.60.1 (#589)

  • Bump numpy from 1.26.3 to 1.26.4 (#595)

  • Bump imageio from 2.33.1 to 2.34.0 (#594)

  • Bump mikepenz/action-junit-report from 3 to 4 (#593)

0.10.6 - 2024-01-11#

Added#

  • Add release note configuration (#512)

  • Add 242 to scheduled nightly run (#519)

  • Add transaction for embedding (#542)

Fixed#

  • Fix pymeilisearch name typo and favicon (#538)

  • Update the gif to reduce the whitespace (#540)

  • Update ansys/actions to v5 (#541)

  • Fix cli find mechanical (#550)

Changed#

  • Update LICENSE (#548)

  • Update license headers and package versions (#556)

Dependencies#

  • Bump github/codeql-action from 2 to 3 (#532)

  • Update pre-commit (#537, #545, #553)

  • Bump pyvista from 0.43.0 to 0.43.1 (#536)

  • Bump panel from 1.3.4 to 1.3.6 (#535, #543)

  • Bump actions/upload-artifact and actions/dwonload-artifactfrom 3 to 4 (#533)

  • Bump jupyter-sphinx from 0.4.0 to 0.5.3 (#547)

  • Bump tj-actions/changed-files from 40 to 41 (#544)

  • Bump pytest from 7.4.3 to 7.4.4 (#546)

  • Bump add-license-headers from 0.2.2 to 0.2.4 (#549)

  • Bump numpy from 1.26.2 to 1.26.3 (#551)

0.10.5 - 2023-12-15#

Added#

  • Add codeql.yml for security checks (#423)

  • add readonly flag and assertion (#441)

  • Add PyMeilisearch in documentation (#508)

  • Add cheetsheat and improve example visibility (#506)

  • Add mechanical-env to workflow (#521)

  • Add doc pdf build to workflow (#529)

Fixed#

  • Fix enum printout (#421)

  • fix appdata tests (#425)

  • Run all embedding tests & fix appdata tests (#433)

  • unset all logging environment variables (#434)

  • pytest –ansys-version dependent on existing install (#439)

  • Fix app.save method for saving already saved project in current session (#453)

  • Flexible version for embedding & remote example (#459)

  • Fix obsolete API call in embedding test (#456)

  • Fix ignored env passing to cli (#465

  • Fix private appdata environment variables and folder layout (#474)

  • Fix hanging embedding tests (#498)

  • Fix ansys-mechanical finding path (#516)

Changed#

  • Update pre-commit (#528)

  • Update python minimum requirement from 3.8 to 3.9 (#484)

  • remove version limit for protobuf (#432)

  • remove legacy configuration test (#436)

  • Update examples page (#450)

  • remove unneeded try/except (#457)

  • Updated wording for revn-variations section (#458)

  • Update temporary file creation in test_app (#466)

  • Remove .reuse and LICENSES directories & bump add-license-header version (#496)

  • Replace workbench_lite with mechanical-env in the docs (#522)

Dependencies#

  • Update pre-commit (#431, #471, #489)

  • Bump numpydoc from 1.5.0 to 1.6.0 (#428)

  • Bump ansys-sphinx-theme from 0.11.2 to 0.12.5 (#427, #463, #480, #493)

  • Bump grpcio from 1.58.0 to 1.60.0 (#429, #485, #504, #527)

  • Bump actions/checkout from 3 to 4 (#426)

  • Bump pyvista from 0.42.2 to 0.43.0 (#446, #526)

  • Bump ansys-sphinx-theme from 0.12.1 to 0.12.2 (#447)

  • Bump stefanzweifel/git-auto-commit-action from 4 to 5 (#448)

  • Bump numpy from 1.26.0 to 1.26.2 (#464, #495)

  • Bump pypandoc from 1.11 to 1.12 (#470)

  • Bump imageio from 2.31.5 to 2.33.1 (#469, #487, #503, #524)

  • Bump add-license-headers from v0.1.3 to v0.2.0 (#472)

  • Bump panel from 1.2.3 to 1.3.4 (#479, #486, #510, #518)

  • Bump pytest from 7.4.2 to 7.4.3 (#482)

  • Bump tj-actions/changed-files from 39 to 40 (#477)

  • Bump plotly from 5.17.0 to 5.18.0 (#478)

  • Bump pandas from 2.1.1 to 2.1.4 (#481, #494, #525)

  • Bump matplotlib from 3.8.0 to 3.8.2 (#488, #502)

  • Bump sphinx-gallery from 0.14.0 to 0.15.0 (#509)

  • Bump actions/labeler from 4 to 5 (#517)

  • Bump actions/setup-python from 4 to 5 (#523)

0.10.4 - 2023-10-06#

Dependencies#

  • Update ansys_mechanical_api from 0.1.0 to 0.1.1 (#444)

0.10.3 - 2023-09-26#

Added#

  • Set up daily run for 241 testing and added manual inputs for workflow dispatch (#385)

  • add option to include enums in global variables (#394)

  • add experimental libraries method (#395)

  • add nonblocking sleep (#399)

  • Add test case for exporting off screen image(#400)

  • Warn for obsolete apis (#409)

Fixed#

  • Fix embedded testing for all python version in CI/CD (#393)

  • fix broken link (#397)

  • use Application.Exit() in 241+ (#396)

  • Fix stale globals by wrapping them (#398)

  • Fix API documentation (#411)

  • doc fix (#412)

Dependencies#

  • Bump sphinx from 7.2.5 to 7.2.6 (#403)

  • Bump matplotlib from 3.7.2 to 3.8.0 (#404

  • Bump imageio-ffmpeg from 0.4.8 to 0.4.9 (#405

  • Bump ansys-sphinx-theme from 0.11.1 to 0.11.2 (#406)

  • Bump plotly from 5.16.1 to 5.17.0 (#407)

  • Bump docker/login-action from 2 to 3 (#408)

  • Bump pyvista from 0.42.1 to 0.42.2 (#414)

0.10.2 - 2023-09-08#

Added#

  • Max parallel 2 for embedding tests - ci_cd.yml (#341)

  • New features for ansys-mechanical console script (#343)

  • Add a “Documentation and issues” section to README and doc landing page (#347)

  • Dependabot changelog automation (#354)

  • Follow up of dependabot automated changelog (#359)

  • Add license headers to files in src (#373)

Changed#

  • Remove library-namespace from CI/CD (#342)

  • Bump grpcio from 1.56.2 to 1.57.0 (#349)

  • Bump plotly from 5.15.0 to 5.16.0 (#348)

  • Bump sphinxcontrib-websupport from 1.2.4 to 1.2.6 (#350)

  • Bump ansys-sphinx-theme from 0.10.2 to 0.10.3 (#351)

  • pre-commit autoupdate (#362), (#380), (#391)

Fixed#

  • Fix private appdata issue (#344)

  • Fix issues with PyPIM object.inv location (#345)

Dependencies#

  • Bump plotly from 5.16.0 to 5.16.1 (#357)

  • Bump sphinx from 7.1.2 to 7.2.5 (#358, #378)

  • Bump sphinx-gallery from 0.13.0 to 0.14.0 (#361)

  • Bump ansys-sphinx-theme from 0.10.3 to 0.11.1 (#360, #387)

  • Bump pytest-print from 0.3.3 to 1.0.0 (#369)

  • Bump tj-actions/changed-files from 37 to 39 (#367, #386)

  • Bump imageio from 2.31.1 to 2.31.2 (#370)

  • Bump pytest from 7.4.0 to 7.4.2 (#375, #389)

  • Bump actions/checkout from 3 to 4 (#379)

  • Bump imageio from 2.31.2 to 2.31.3 (#376)

  • Bump sphinx-notfound-page from 1.0.0rc1 to 1.0.0 (#374)

  • Bump pyvista from 0.42.0 to 0.42.1 (#388)

0.10.1 - 2023-08-08#

Changed#

  • Bump ansys-sphinx-theme from 0.10.0 to 0.10.2 (#337)

  • Update clr-loader dependency (#339)

0.10.0 - 2023-08-07#

Added#

  • Added warning for ansys-mechanical when provided an input script (#319)

  • Add changelog check to CI/CD (#322)

  • Added version check for ansys-mechanical warning message (#323)

  • Added TempPathFactory to test_app_save_open (#332)

Changed#

  • Update python minimum requirement from 3.7 to 3.8 (#333)

  • Minor private appdata updates (#335)

Fixed#

  • Broken links (#316)

  • Remove project lock file on close (#320)

  • Fixed warning message for ansys-mechanical (#326)

0.9.3 - 2023-07-27#

Added#

  • Add ansys-mechanical console script (#297)

  • addin configuration and tests (#308)

Changed#

  • Bump matplotlib from 3.7.1 to 3.7.2 (#294)

  • Bump pyvista from 0.40.0 to 0.40.1 (#293)

  • Bump sphinx-autodoc-typehints from 1.23.0 to 1.23.3 (#284)

  • Bump patch version (#292)

  • Remove pkg-resources and importlib_metadata (#300)

  • Bump grpcio from 1.56.0 to 1.56.2 (#305)

  • Bump pyvista from 0.40.1 to 0.41.1 (#306)

Fixed#

  • Update code snippet for accessing project directory. (#295)

  • Added import logging to doc file (#299)

  • Fix version variable issue running “ansys-mechanical -r {revn} -g” (#302)

  • Update wording in running_mechanical.rst (#303)

0.9.2 - 2023-07-07#

Added#

  • Added private AppData functionality to embedding (#285)

Fixed#

  • Updated pythonnet warning message (#286)

Changed#

  • Bump pytest from 7.3.2 to 7.4.0 (#282)

  • Bump grpcio from 1.54.2 to 1.56.0 (#283)

0.9.1 - 2023-06-21#

Added#

  • Add version configuration for embedding tests (#270)

Changed#

  • Bump pytest-print from 0.3.1 to 0.3.2 (#273)

Fixed#

  • FIX: Use updated ansys-tools-path to resolve - missing 1 required positional argument: ‘exe_loc’ issue (#280)

0.9.0 - 2023-06-13#

Added#

  • link to pymechanical remote sessions examples (#252)

  • add doc to run script without embedding (#262)

  • pre-commit autoupdate (#269)

Changed#

  • Bump ansys-sphinx-theme from 0.9.8 to 0.9.9 (#248)

  • Bump grpcio from 1.54.0 to 1.54.2 (#249)

  • Bump sphinx from 6.2.0 to 6.2.1 (#250)

  • change image tag in ci/cd (#254)

  • Bump pyvista from 0.39.0 to 0.39.1 (#256)

  • Standardizing data paths (#257)

  • Bump imageio from 2.28.1 to 2.30.0 (#258)

  • Bump pytest-cov from 4.0.0 to 4.1.0 (#259)

  • Bump imageio from 2.30.0 to 2.31.0 (#264)

  • Bump pytest from 7.3.1 to 7.3.2 (#267)

  • Bump plotly from 5.14.1 to 5.15.0 (#268)

Fixed#

  • FIX: GitHub organization rename to Ansys (#251)

  • fix examples links (#253)

  • fix windows pythonnet warning unit tests (#260)

0.8.0 - 2023-05-12#

Added#

  • changelog (#222)

  • add link to embedding examples (#228)

  • Add close() method to Ansys.Mechanical.Embedding.Application. See (#229)

  • Add check if pythonnet exists in the user environment (#235)

Changed#

  • cleanup docker ignore file (#206)

  • Update contributing.rst (#213)

  • Bump sphinx-autodoc-typehints from 1.22 to 1.23.0 (#215)

  • Bump pytest from 7.3.0 to 7.3.1 (#216)

  • Bump sphinx-gallery from 0.12.2 to 0.13.0 (#217)

  • Bump sphinx-copybutton from 0.5.1 to 0.5.2 (#218)

  • Bump sphinx-design from 0.3.0 to 0.4.1 (#219)

  • Remove python 3.7 (#230)

  • Use ansys-tools-path (#231)

  • Bump sphinx from 6.2.0 to 7.0.0 (#232)

  • Bump imageio from 2.28.0 to 2.28.1 (#233)

  • ignore generated .ipynb, .py, .rst, .md5, .png and .pickle files (#239)

  • Bump pyvista from 0.38.5 to 0.39.0 (#245)

Fixed#

  • FIX: not necessary anymore to update apt-get (#220)

  • Include amd folder for mapdl solver in the docker image. (#200)

  • Remove jscript references from tests/ folder (#205)

  • Fixes the windows executable path for standalone mechanical (#214)

  • FIX: run_python_script* return empty string for objects that cannot be returned as string (#224)

  • call new() in the BUILDING_GALLERY constructor of Ansys.Mechanical.Embedding.Application (#229)

  • fix documentation link (#234)

  • changed python doc url to fix doc pipeline error (#236)

  • Docker dependencies to support topo and smart tests (#237)

0.7.3 - 2023-04-20#

Changed#

  • Reuse instance of embedded application when building example gallery (#221)

0.7.2 - 2023-04-13#

Changed#

  • Bump plotly from 5.14.0 to 5.14.1 (#197)

  • Bump pytest from 7.2.2 to 7.3.0 (#196)

  • Bump peter-evans/create-or-update-comment from 2 to 3 (#195)

  • Bump ansys-sphinx-theme from 0.9.6 to 0.9.7 (#198)

Fixed#

  • Fixed documentation for updating global variables (#203)

  • Remove references to unsupported legacy jscript APIs (#205)

  • Clean up docker image (#206, #200)

0.7.1 - 2023-04-10#

First public release of PyMechanical