Version Change to v0.11.0

.github/labeler.yml

@@ -4,7 +4,7 @@ documentation:
 
 maintenance:
 - changed-files:
-  - any-glob-to-any-file: ['.github/**/*', 'codecov.yml', '.flake8', '.coveragerc', '.codespellrc', '.pre-commit-config.yaml', 'tox.ini']
+  - any-glob-to-any-file: ['.github/**/*', '.pre-commit-config.yaml']
 
 dependencies:
 - changed-files:

.gitignore

@@ -197,6 +197,13 @@ doc/source/examples/gallery_examples/*/*.rst
 doc/source/examples/gallery_examples/*/*.pickle
 doc/source/examples/gallery_examples/**/*.png
 doc/source/sg_execution_times.rst
+# Ignore everything in the doc/source/api/ directory
+doc/source/api/*
+# This file is for the ansys-tools-path
+!doc/source/api/path.rst
+
+# Examples files downloaded when building docs
+examples/embedding_n_remote/download/*
 
 # pymechanical-specific
 mylocal.ip

.pre-commit-config.yaml

@@ -1,5 +1,10 @@
 repos:
 
+- repo: https://github.com/pre-commit-ci/pre-commit-ci-config
+  rev: v1.6.1
+  hooks:
+  -   id: check-pre-commit-ci-config
+
 - repo: https://github.com/psf/black
   rev: 24.4.2  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
@@ -17,14 +22,16 @@ repos:
   - id: isort
 
 - repo: https://github.com/PyCQA/flake8
-  rev: 7.0.0
+  rev: 7.1.0
   hooks:
   - id: flake8
+    additional_dependencies: [flake8-pyproject]
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.6
+  rev: v2.3.0
   hooks:
   - id: codespell
+    args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt", "-w"]
 
 - repo: https://github.com/ansys/pre-commit-hooks
   rev: v0.3.1
@@ -56,5 +63,11 @@ repos:
   - id: debug-statements
   - id: check-yaml
   - id: trailing-whitespace
+  - id: check-added-large-files
+
+- repo: https://github.com/python-jsonschema/check-jsonschema
+  rev: 0.28.5
+  hooks:
+    - id: check-github-workflows
 
 exclude: '^tests/embedding/assets/.*$|^tests/parts/.*$'

AUTHORS.md

@@ -1,15 +1,12 @@
-# Authors
-
-## Project Lead
-
-* [Sam Sangili](https://github.com/samigithub2022)
-
-## Contributors
-
-* [Alexander Kaszynski](https://github.com/akaszynski)
-* [Dipin Nair](https://github.com/dipinknair)
-* [Kathy Pippert](https://github.com/PipKat)
-* [Kerry McAdams](https://github.com/klmcadams)
-* [Maxime Rey](https://github.com/MaxJPRey)
-* [Mohamed Koubaa](https://github.com/koubaa)
-* [Roberto Pastor](https://github.com/RobPasMue)
+# This is the list of PyMechanical's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and want to be added to this file,
+# submit a request.
+#
+#
+ANSYS, Inc.

CODE_OF_CONDUCT.md

@@ -7,7 +7,7 @@ contributors and maintainers pledge to making participation in our
 project and our community a harassment-free experience for everyone,
 regardless of age, body size, disability, ethnicity, sex
 characteristics, gender identity and expression, level of experience,
-education, socio-economic status, nationality, personal appearance,
+education, socioeconomic status, nationality, personal appearance,
 race, religion, or sexual identity and orientation.
 
 ## Our Standards

CONTRIBUTING.md

@@ -1,5 +1,16 @@
-# Contributing
+# Contributors
 
-For contributing to this project, please refer to the [PyAnsys Developer's Guide].
+## Project Lead
 
-[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/
+* [Sam Sangili](https://github.com/samigithub2022)
+* [Mohamed Koubaa](https://github.com/koubaa)
+
+## Individual Contributors
+
+* [Alexander Kaszynski](https://github.com/akaszynski)
+* [Dipin Nair](https://github.com/dipinknair)
+* [Kathy Pippert](https://github.com/PipKat)
+* [Kerry McAdams](https://github.com/klmcadams)
+* [Maxime Rey](https://github.com/MaxJPRey)
+* [Revathy Venugopal](https://github.com/Revathyvenugopal162)
+* [Roberto Pastor](https://github.com/RobPasMue)

README.rst

@@ -17,7 +17,7 @@
    :alt: Python
 
 .. |codecov| image:: https://codecov.io/gh/ansys/pymechanical/branch/main/graph/badge.svg
-   :target: https://codecov.io/gh/ansys/ansys-mechanical-core
+   :target: https://app.codecov.io/gh/ansys/pymechanical
    :alt: Codecov
 
 .. |GH-CI| image:: https://github.com/ansys/pymechanical/actions/workflows/ci_cd.yml/badge.svg
@@ -32,9 +32,13 @@
    :target: https://github.com/psf/black
    :alt: Black
 
+.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pymechanical/main.svg?style=flat
+   :target: https://results.pre-commit.ci/latest/github/ansys/pymechanical/main
+   :alt: pre-commit
 
 Overview
 --------
+
 PyMechanical brings Ansys Mechanical to Python. It enables your Python programs to use
 Mechanical within Python's ecosystem. It includes the ability to:
 
@@ -44,6 +48,7 @@ Mechanical within Python's ecosystem. It includes the ability to:
 
 Install the package
 -------------------
+
 Install PyMechanical using `pip` with::
 
    pip install ansys-mechanical-core
@@ -121,7 +126,7 @@ Documentation and issues
 ------------------------
 
 Documentation for the latest stable release of PyMechanical is hosted at `PyMechanical documentation
-<https://mechanical.docs.pyansys.com/version/stable/>`_.
+<https://mechanical.docs.pyansys.com/>`_.
 
 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
@@ -144,15 +149,4 @@ Testing and development
 
 If you would like to test or contribute to the development of PyMechanical, see
 `Contribute <https://mechanical.docs.pyansys.com/version/stable/contributing.html>`_ in
-the PyMechanical documentation.
-
-.. LINKS AND REFERENCES
-.. _black: https://github.com/psf/black
-.. _flake8: https://flake8.pycqa.org/en/latest/
-.. _isort: https://github.com/PyCQA/isort
-.. _pip: https://pypi.org/project/pip/
-.. _pre-commit: https://pre-commit.com/
-.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/
-.. _pytest: https://docs.pytest.org/en/stable/
-.. _Sphinx: https://www.sphinx-doc.org/en/master/
-.. _tox: https://tox.wiki/
+the PyMechanical documentation.

doc/changelog.d/749.changed.md

@@ -0,0 +1 @@
+chore: update CHANGELOG for v0.10.11

doc/changelog.d/750.changed.md

@@ -0,0 +1 @@
+MAINT: Delete the apt-get lists after installing packages

doc/changelog.d/751.dependencies.md

@@ -0,0 +1 @@
+MAINT: Bump the doc group with 4 updates

doc/changelog.d/752.dependencies.md

@@ -0,0 +1 @@
+[pre-commit.ci] pre-commit autoupdate

doc/changelog.d/753.added.md

@@ -0,0 +1 @@
+feat: raise an exception if port or input script aren't provided in batch mode

doc/changelog.d/755.dependencies.md

@@ -0,0 +1 @@
+MAINT: Bump the doc group with 3 updates

doc/changelog.d/757.added.md

@@ -0,0 +1 @@
+feat: use changelog.rst instead of CHANGELOG.md for release notes

doc/changelog.d/758.added.md

@@ -0,0 +1 @@
+Doc: Add embedding api references

doc/changelog.d/761.added.md

@@ -0,0 +1 @@
+feat: implement autoapi

doc/changelog.d/762.dependencies.md

@@ -0,0 +1 @@
+MAINT: Update files as per pyansys standards

doc/changelog.d/763.fixed.md

@@ -0,0 +1 @@
+FIX: Modify pre-commit hook

doc/changelog.d/764.dependencies.md

@@ -0,0 +1 @@
+MAINT: Bump grpcio from 1.64.0 to 1.64.1 in the core group

doc/changelog.d/765.dependencies.md

@@ -0,0 +1 @@
+MAINT: Bump pytest from 8.2.1 to 8.2.2 in the tests group

doc/changelog.d/766.dependencies.md

@@ -0,0 +1 @@
+MAINT: Bump the doc group with 2 updates

doc/changelog.d/767.miscellaneous.md

@@ -0,0 +1 @@
+add method to update globals

doc/changelog.d/768.fixed.md

@@ -0,0 +1 @@
+fix lifetime issue

doc/changelog.d/772.fixed.md

@@ -0,0 +1 @@
+fix pythonnet issue

doc/changelog.d/774.changed.md

@@ -0,0 +1 @@
+[pre-commit.ci] pre-commit autoupdate

doc/changelog.d/776.fixed.md

@@ -0,0 +1 @@
+Fix: Remove disable sec check

doc/changelog.d/changelog_template.jinja

@@ -1,7 +1,9 @@
 {% if sections[""] %}
 {% for category, val in definitions.items() if category in sections[""] %}
 
-### {{ definitions[category]['name'] }}
+{{ definitions[category]['name'] }}
+{% set underline = '^' * definitions[category]['name']|length %}
+{{ underline }}
 
 {% for text, values in sections[""][category].items() %}
 - {{ text }} {{ values|join(', ') }}

doc/source/_templates/autoapi/index.rst

@@ -0,0 +1,22 @@
+.. vale off
+
+API reference
+=============
+
+This section describes {{ project_name }} endpoints, their capabilities, and how
+to interact with them programmatically.
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+   {% for page in pages %}
+   {% if (page.top_level_object or page.name.split('.') | length == 3) and page.display %}
+   <span class="nf nf-md-package"></span> {{ page.name }}<{{ page.include_path }}>
+   {% endif %}
+   {% endfor %}
+
+Additionally, see the API references for ``ansys-tools-path`` `here <path.html>`_ .
+
+
+.. vale on