Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/ci-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:
matrix:
os: [windows-latest, ubuntu-latest]
python-version: ['3.8', '3.9', '3.10', '3.11']
extras-version: ['fluent-all', 'mapdl-all']
extras-version: ['fluent-all', 'mapdl-all', 'tools']

steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -110,7 +110,6 @@ jobs:
uses: ansys/actions/build-wheelhouse@v4
with:
library-name: ${{ env.PACKAGE_NAME }}
library-namespace: ${{ env.PACKAGE_NAMESPACE }}
operating-system: ${{ runner.os }}
python-version: ${{ matrix.python-version }}
target: "all"
Expand Down
40 changes: 24 additions & 16 deletions .github/workflows/create-milestone.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,31 +19,39 @@ jobs:
matrix:
pyansys-projects:
[
"ansys/pymapdl",
"ansys/pymapdl-reader",
"ansys/pydpf-composites",
"ansys/pydpf-core",
"ansys/pydpf-post",
"ansys/pydpf-composites",
"ansys/pydyna",
"ansys/pydynamicreporting",
"ansys/pyensight",
"ansys/pyfluent",
"ansys/pyfluent-parametric",
"ansys/pyfluent-visualization",
"ansys/pyaedt",
"ansys/pypim",
"ansys/pyansys-geometry",
"ansys/grantami-bomanalytics",
"ansys/grantami-recordlists",
"ansys/pyfluent",
"ansys/pymapdl",
"ansys/pyansys-math",
"ansys/pymechanical",
"ansys/pyprimemesh",
"ansys/pymotorcad",
"ansys/pypim",
"ansys/pyensight",
"ansys/openapi-common",
"ansys/pyoptislang",
"ansys/pyseascape",
"ansys/pysherlock",
"ansys/pyprimemesh",
"ansys/pytwin",
"ansys/pysystem-coupling",
"ansys/pymotorcad",
"ansys/pyansys-math",
"ansys/pyoptislang",
"ansys/pymechanical",
"ansys/pydyna",
"ansys/pyaedt",
"ansys/pytwin",
# MAPDL - ALL
"ansys/pymapdl-reader",
# FLUENT - ALL
"ansys/pyfluent-parametric",
"ansys/pyfluent-visualization",
# TOOLS
"ansys/ansys-tools-path",
"ansys/pyansys-tools-report",
"ansys/pyansys-tools-versioning",
"ansys/pyansys-units",
]
steps:
- uses: actions/checkout@v4
Expand Down
12 changes: 11 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ of these packages amongst themselves and the Ansys product release that they are
The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages:

- `PyAEDT <https://aedt.docs.pyansys.com/>`_: Pythonic interface to AEDT (Ansys Electronics Desktop).
- `PyAnsys Geometry <https://geometry.docs.pyansys.com/>`_: Pythonic interface to the Ansys Geometry service.
- `PyAnsys Math <https://math.docs.pyansys.com/>`_: Pythonic interface to PyAnsys Math libraries.
- `PyDPF - Core <https://dpf.docs.pyansys.com/>`_: Pythonic interface to Ansys DPF (Data Processing Framework) for building more advanced and customized workflows.
- `PyDPF - Post <https://post.docs.pyansys.com/>`_: Pythonic interface to access and post process Ansys solver result files.
Expand All @@ -62,6 +63,13 @@ The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages
- `Granta MI RecordLists <https://recordlists.grantami.docs.pyansys.com/>`_: Pythonic interface to Ansys Granta MI Lists API.
- `Shared Components <https://shared.docs.pyansys.com/>`_: Shared Ansys software components to enable package interoperability and minimize maintenance.

Other tools delivered as part of the metapackage are:

- `Ansys Tools Path <https://path.tools.docs.pyansys.com/>`_: Library to locate Ansys products in a local machine.
- `PyAnsys Tools Report <https://report.tools.docs.pyansys.com/>`_: Tool for reporting your Python environment's package versions and hardware resources in a standardized way.
- `PyAnsys Tools Versioning <https://versioning.tools.docs.pyansys.com/>`_: Tool for backwards and forwards server support.
- `PyAnsys Units <https://units.docs.pyansys.com/>`_: Pythonic interface for units, unit systems, and unit conversions.

Much effort is underway to continue expanding and developing packages in the
`PyAnsys GitHub <https://github.com/ansys/>`__ account. On the ``Issues`` page
for each package, you can post issues and request new features. You can also feel
Expand All @@ -70,6 +78,7 @@ free to post a question on the `Ansys Developer Forums <https://discuss.ansys.co
By default, the PyAnsys metapackage installs these core modules:

- `PyAEDT`_
- `PyAnsys Geometry`_
- `PyAnsys Math`_
- `PyDPF - Core`_
- `PyDPF - Post`_
Expand All @@ -96,7 +105,8 @@ Additionally, the ``pyansys`` metapackage contains certain extra targets that
can be installed upon request:

- **mapdl-all**: This target installs the core packages and `PyMAPDL Reader`_.
- **fluent-all**: This target installs the core packages and `PyFluent - Parametric`_ and `PyFluent - Visualization`_.
- **fluent-all**: This target installs the core packages, `PyFluent - Parametric`_, and `PyFluent - Visualization`_.
- **tools**: This target installs the core packages, `Ansys Tools Path`_, `PyAnsys Tools Versioning`_, `PyAnsys Tools Report`_, and `PyAnsys Units`_.
- **all**: This target installs all extra ``pyansys`` packages.

Package installation
Expand Down
2 changes: 1 addition & 1 deletion doc/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ if errorlevel 9009 (
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
echo.https://sphinx-doc.org/
exit /b 1
)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ PyAnsys packages API reference
:class-title: pyansys-card-title
:margin: 2 2 0 0

.. grid-item-card:: PyAnsys Geometry
:img-top: _static/thumbnails/pyansys-geometry.png
:link: https://geometry.docs.pyansys.com/version/stable/api/index.html
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

.. grid-item-card:: PyAnsys Math
:img-top: _static/thumbnails/pyansys-math.png
:link: https://math.docs.pyansys.com/version/stable/api/index.html
Expand Down
7 changes: 7 additions & 0 deletions doc/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ PyAnsys packages examples
:class-title: pyansys-card-title
:margin: 2 2 0 0

.. grid-item-card:: PyAnsys Geometry
:img-top: _static/thumbnails/pyansys-geometry.png
:link: https://geometry.docs.pyansys.com/version/stable/examples.html
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

.. grid-item-card:: PyAnsys Math
:img-top: _static/thumbnails/pyansys-math.png
:link: https://math.docs.pyansys.com/version/stable/examples/index.html
Expand Down
10 changes: 10 additions & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ it is now a collection of many Python packages for using Ansys products through
user_guide
api
examples
tools

.. grid:: 3

Expand All @@ -25,6 +26,15 @@ it is now a collection of many Python packages for using Ansys products through

Pythonic interface to AEDT (Ansys Electronic Desktop)

.. grid-item-card:: PyAnsys Geometry
:img-top: _static/thumbnails/pyansys-geometry.png
:link: https://geometry.docs.pyansys.com/version/stable
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Pythonic interface to the Ansys Geometry service

.. grid-item-card:: PyAnsys Math
:img-top: _static/thumbnails/pyansys-math.png
:link: https://math.docs.pyansys.com/version/stable
Expand Down
80 changes: 80 additions & 0 deletions doc/source/tools.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
Other tools
===========

Tooling libraries delivered with the **extra** target as well as other standalone tools
that can be installed or used.

*******************
Standalone projects
*******************

.. grid:: 3

.. grid-item-card:: Ansys Python Manager
:img-top: _static/thumbnails/ansys-python-manager.png
:link: https://installer.docs.pyansys.com/version/stable
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Simple cross-platform QT application to install Python and PyAnsys packages

.. grid-item-card:: Ansys ``pre-commit`` hooks
:img-top: _static/thumbnails/intro.png
:link: https://pre-commit-hooks.docs.ansys.com/version/stable
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Ansys repository containing customized pre-commit hooks

.. grid-item-card:: Ansys Tools Repository Sync
:img-top: _static/thumbnails/intro.png
:link: https://ansys.github.io/ansys-tools-repo-sync/version/stable
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Ansys tool intended to synchronize the content of two different repositories

*****************
Tooling libraries
*****************

.. grid:: 3

.. grid-item-card:: Ansys Tools Path
:img-top: _static/thumbnails/intro.png
:link: https://path.tools.docs.pyansys.com/version/stable
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Library to locate Ansys products in a local machine

.. grid-item-card:: PyAnsys Tools Report
:img-top: _static/thumbnails/intro.png
:link: https://report.tools.docs.pyansys.com/version/stable/
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Tool for reporting your Python environment's package versions and hardware resources in a standardized way

.. grid-item-card:: PyAnsys Tools Versioning
:img-top: _static/thumbnails/intro.png
:link: https://versioning.tools.docs.pyansys.com/version/stable/
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Tool for backwards and forwards server support

.. grid-item-card:: PyAnsys Units
:img-top: _static/thumbnails/intro.png
:link: https://units.docs.pyansys.com/version/stable/
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Pythonic interface for units, unit systems, and unit conversions
7 changes: 7 additions & 0 deletions doc/source/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ PyAnsys packages user guides
:class-title: pyansys-card-title
:margin: 2 2 0 0

.. grid-item-card:: PyAnsys Geometry
:img-top: _static/thumbnails/pyansys-geometry.png
:link: https://geometry.docs.pyansys.com/version/stable/user_guide/index.html
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

.. grid-item-card:: PyAnsys Math
:img-top: _static/thumbnails/pyansys-math.png
:link: https://math.docs.pyansys.com/version/stable/user_guide/index.html
Expand Down
44 changes: 29 additions & 15 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,30 @@ classifiers = [

dependencies = [
"importlib-metadata>=4.0,<5; python_version<='3.8'",
"ansys-mapdl-core==0.65.2",
"ansys-dpf-composites==0.3.0",
"ansys-dpf-core==0.9.0",
"ansys-dpf-post==0.5.0",
"ansys-dpf-gate==0.4.1",
"ansys-dpf-composites==0.3.0",
"ansys-dyna-core==0.4.2",
"ansys-dynamicreporting-core==0.4.0",
"ansys-pyensight-core==0.5.7",
"ansys-fluent-core==0.17.0",
"pyaedt==0.6.92",
"ansys-platform-instancemanagement==1.1.2",
"ansys-geometry-core==0.3.1",
"ansys-grantami-bomanalytics==1.2.0",
"ansys-grantami-recordlists==1.0.0.post1",
"ansys-fluent-core==0.17.0",
"ansys-mapdl-core==0.65.2",
"ansys-math-core==0.1.3",
"ansys-mechanical-core==0.10.2",
"ansys-meshing-prime==0.4.0",
"ansys-motorcad-core==0.2.0",
"ansys-platform-instancemanagement==1.1.2",
"ansys-pyensight-core==0.5.7",
"ansys-openapi-common==1.2.2",
"ansys-optislang-core==0.4.0",
"ansys-seascape==0.2.0",
"ansys-sherlock-core==0.3.0",
"ansys-meshing-prime==0.4.0",
"pytwin==0.4.0",
"ansys-systemcoupling-core==0.2.0",
"ansys-motorcad-core==0.2.0",
"ansys-math-core==0.1.3",
"ansys-optislang-core==0.4.0",
"ansys-mechanical-core==0.10.2",
"pyaedt==0.6.92",
"pytwin==0.4.0",
]

[project.optional-dependencies]
Expand All @@ -59,14 +60,27 @@ fluent-all = [
"ansys-fluent-visualization==0.7.1",
"ansys-fluent-parametric==0.8.0",
]
all = [
tools = [
"ansys-units==0.1.0",
"ansys-tools-path==0.3.1",
"pyansys-tools-report==0.6.0",
"pyansys-tools-versioning==0.4.0",
]
all = [
# MAPDL - ALL
"ansys-mapdl-reader==0.52.20",
# FLUENT - ALL
"ansys-fluent-visualization==0.7.1",
"ansys-fluent-parametric==0.8.0",
# TOOLS
"ansys-units==0.1.0",
"ansys-tools-path==0.3.1",
"pyansys-tools-report==0.6.0",
"pyansys-tools-versioning==0.4.0",
]
doc = [
"Sphinx==7.2.2",
"ansys-sphinx-theme==0.11.1",
"Sphinx==7.2.6",
"ansys-sphinx-theme==0.11.2",
"sphinx-copybutton==0.5.2",
"sphinx-design==0.5.0",
]
Expand Down
38 changes: 23 additions & 15 deletions tools/links.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,40 @@
"""Path to the documentation source directory"""

LINKS = {
"ansys-mapdl-core": "https://mapdl.docs.pyansys.com/version/stable",
"ansys-mapdl-reader": "https://reader.docs.pyansys.com/version/stable",
"ansys-dpf-composites": "https://composites.dpf.docs.pyansys.com/version/stable", # noqa: E501
"ansys-dpf-core": "https://dpf.docs.pyansys.com/version/stable",
"ansys-dpf-post": "https://post.docs.pyansys.com/version/stable",
"ansys-dpf-gate": None,
"ansys-dpf-composites": "https://composites.dpf.docs.pyansys.com/version/stable", # noqa: E501
"ansys-dyna-core": "https://dyna.docs.pyansys.com/version/stable",
"ansys-dynamicreporting-core": "https://dynamicreporting.docs.pyansys.com/version/stable", # noqa: E501
"ansys-pyensight-core": "https://ensight.docs.pyansys.com/version/stable",
"ansys-fluent-core": "https://fluent.docs.pyansys.com/version/stable",
"ansys-fluent-visualization": "https://visualization.fluent.docs.pyansys.com/version/stable", # noqa: E501
"ansys-fluent-parametric": "https://parametric.fluent.docs.pyansys.com/version/stable", # noqa: E501
"pyaedt": "https://aedt.docs.pyansys.com/version/stable",
"ansys-platform-instancemanagement": "https://pypim.docs.pyansys.com/version/stable", # noqa: E501
"ansys-geometry-core": "https://geometry.docs.pyansys.com/version/stable",
"ansys-grantami-bomanalytics": "https://bomanalytics.grantami.docs.pyansys.com/version/stable", # noqa: E501
"ansys-grantami-recordlists": "https://recordlists.grantami.docs.pyansys.com/version/stable", # noqa: E501
"ansys-fluent-core": "https://fluent.docs.pyansys.com/version/stable",
"ansys-mapdl-core": "https://mapdl.docs.pyansys.com/version/stable",
"ansys-math-core": "https://math.docs.pyansys.com/version/stable",
"ansys-mechanical-core": "https://mechanical.docs.pyansys.com/version/stable", # noqa: E501
"ansys-meshing-prime": "https://prime.docs.pyansys.com/version/stable",
"ansys-motorcad-core": "https://motorcad.docs.pyansys.com/version/stable",
"ansys-platform-instancemanagement": "https://pypim.docs.pyansys.com/version/stable", # noqa: E501
"ansys-pyensight-core": "https://ensight.docs.pyansys.com/version/stable",
"ansys-openapi-common": None,
"ansys-optislang-core": "https://optislang.docs.pyansys.com/version/stable", # noqa: E501
"ansys-seascape": "https://seascape.docs.pyansys.com/version/stable",
"ansys-sherlock-core": "https://sherlock.docs.pyansys.com/version/stable",
"ansys-meshing-prime": "https://prime.docs.pyansys.com/version/stable",
"pytwin": "https://twin.docs.pyansys.com/version/stable",
"ansys-systemcoupling-core": "https://systemcoupling.docs.pyansys.com/version/stable", # noqa: E501
"ansys-motorcad-core": "https://motorcad.docs.pyansys.com/version/stable",
"ansys-math-core": "https://math.docs.pyansys.com/version/stable",
"ansys-optislang-core": "https://optislang.docs.pyansys.com/version/stable", # noqa: E501
"ansys-mechanical-core": "https://mechanical.docs.pyansys.com/version/stable", # noqa: E501
"pyaedt": "https://aedt.docs.pyansys.com/version/stable",
"pytwin": "https://twin.docs.pyansys.com/version/stable",
# MAPDL - ALL
"ansys-mapdl-reader": "https://reader.docs.pyansys.com/version/stable",
# FLUENT - ALL
"ansys-fluent-visualization": "https://visualization.fluent.docs.pyansys.com/version/stable", # noqa: E501
"ansys-fluent-parametric": "https://parametric.fluent.docs.pyansys.com/version/stable", # noqa: E501
# TOOLS
"ansys-units": "https://units.docs.pyansys.com/version/stable",
"ansys-tools-path": "https://path.tools.docs.pyansys.com/version/stable",
"pyansys-tools-report": "https://report.tools.docs.pyansys.com/version/stable", # noqa: E501
"pyansys-tools-versioning": "https://versioning.tools.docs.pyansys.com/version/stable", # noqa: E501
}
"""Dictionary with PyAnsys packages and their multi-version docs site."""

Expand Down