Skip to content

Commit 990ce4b

Browse files
RobPasMueRobPasMue
authored
feat: add packages and reorg (#361)
1 parent b85e8bb commit 990ce4b

File tree

13 files changed

+200
-50
lines changed

13 files changed

+200
-50
lines changed

‎.github/workflows/ci-build.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676
matrix:
7777
os: [windows-latest, ubuntu-latest]
7878
python-version: ['3.8', '3.9', '3.10', '3.11']
79-
extras-version: ['fluent-all', 'mapdl-all']
79+
extras-version: ['fluent-all', 'mapdl-all', 'tools']
8080

8181
steps:
8282
- uses: actions/checkout@v4
@@ -110,7 +110,6 @@ jobs:
110110
uses: ansys/actions/build-wheelhouse@v4
111111
with:
112112
library-name: ${{ env.PACKAGE_NAME }}
113-
library-namespace: ${{ env.PACKAGE_NAMESPACE }}
114113
operating-system: ${{ runner.os }}
115114
python-version: ${{ matrix.python-version }}
116115
target: "all"

‎.github/workflows/create-milestone.yml‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,39 @@ jobs:
1919
matrix:
2020
pyansys-projects:
2121
[
22-
"ansys/pymapdl",
23-
"ansys/pymapdl-reader",
22+
"ansys/pydpf-composites",
2423
"ansys/pydpf-core",
2524
"ansys/pydpf-post",
26-
"ansys/pydpf-composites",
25+
"ansys/pydyna",
2726
"ansys/pydynamicreporting",
28-
"ansys/pyensight",
29-
"ansys/pyfluent",
30-
"ansys/pyfluent-parametric",
31-
"ansys/pyfluent-visualization",
32-
"ansys/pyaedt",
33-
"ansys/pypim",
27+
"ansys/pyansys-geometry",
3428
"ansys/grantami-bomanalytics",
3529
"ansys/grantami-recordlists",
30+
"ansys/pyfluent",
31+
"ansys/pymapdl",
32+
"ansys/pyansys-math",
33+
"ansys/pymechanical",
34+
"ansys/pyprimemesh",
35+
"ansys/pymotorcad",
36+
"ansys/pypim",
37+
"ansys/pyensight",
3638
"ansys/openapi-common",
39+
"ansys/pyoptislang",
3740
"ansys/pyseascape",
3841
"ansys/pysherlock",
39-
"ansys/pyprimemesh",
40-
"ansys/pytwin",
4142
"ansys/pysystem-coupling",
42-
"ansys/pymotorcad",
43-
"ansys/pyansys-math",
44-
"ansys/pyoptislang",
45-
"ansys/pymechanical",
46-
"ansys/pydyna",
43+
"ansys/pyaedt",
44+
"ansys/pytwin",
45+
# MAPDL - ALL
46+
"ansys/pymapdl-reader",
47+
# FLUENT - ALL
48+
"ansys/pyfluent-parametric",
49+
"ansys/pyfluent-visualization",
50+
# TOOLS
51+
"ansys/ansys-tools-path",
52+
"ansys/pyansys-tools-report",
53+
"ansys/pyansys-tools-versioning",
54+
"ansys/pyansys-units",
4755
]
4856
steps:
4957
- uses: actions/checkout@v4

‎README.rst‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ of these packages amongst themselves and the Ansys product release that they are
3737
The ``pyansys`` metapackage ensures compatibility between these PyAnsys packages:
3838

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

66+
Other tools delivered as part of the metapackage are:
67+
68+
- `Ansys Tools Path <https://path.tools.docs.pyansys.com/>`_: Library to locate Ansys products in a local machine.
69+
- `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.
70+
- `PyAnsys Tools Versioning <https://versioning.tools.docs.pyansys.com/>`_: Tool for backwards and forwards server support.
71+
- `PyAnsys Units <https://units.docs.pyansys.com/>`_: Pythonic interface for units, unit systems, and unit conversions.
72+
6573
Much effort is underway to continue expanding and developing packages in the
6674
`PyAnsys GitHub <https://github.com/ansys/>`__ account. On the ``Issues`` page
6775
for each package, you can post issues and request new features. You can also feel
@@ -70,6 +78,7 @@ free to post a question on the `Ansys Developer Forums <https://discuss.ansys.co
7078
By default, the PyAnsys metapackage installs these core modules:
7179

7280
- `PyAEDT`_
81+
- `PyAnsys Geometry`_
7382
- `PyAnsys Math`_
7483
- `PyDPF - Core`_
7584
- `PyDPF - Post`_
@@ -96,7 +105,8 @@ Additionally, the ``pyansys`` metapackage contains certain extra targets that
96105
can be installed upon request:
97106

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

102112
Package installation

‎doc/make.bat‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ if errorlevel 9009 (
2121
echo.may add the Sphinx directory to PATH.
2222
echo.
2323
echo.If you don't have Sphinx installed, grab it from
24-
echo.http://sphinx-doc.org/
24+
echo.https://sphinx-doc.org/
2525
exit /b 1
2626
)
2727

‎doc/source/_static/thumbnails/ansys-python-manager.png‎

67 KB
Loading

‎doc/source/_static/thumbnails/pyansys-geometry.png‎

10.4 KB
Loading

‎doc/source/api.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ PyAnsys packages API reference
2727
:class-title: pyansys-card-title
2828
:margin: 2 2 0 0
2929

30+
.. grid-item-card:: PyAnsys Geometry
31+
:img-top: _static/thumbnails/pyansys-geometry.png
32+
:link: https://geometry.docs.pyansys.com/version/stable/api/index.html
33+
:text-align: center
34+
:class-title: pyansys-card-title
35+
:margin: 2 2 0 0
36+
3037
.. grid-item-card:: PyAnsys Math
3138
:img-top: _static/thumbnails/pyansys-math.png
3239
:link: https://math.docs.pyansys.com/version/stable/api/index.html

‎doc/source/examples.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ PyAnsys packages examples
1616
:class-title: pyansys-card-title
1717
:margin: 2 2 0 0
1818

19+
.. grid-item-card:: PyAnsys Geometry
20+
:img-top: _static/thumbnails/pyansys-geometry.png
21+
:link: https://geometry.docs.pyansys.com/version/stable/examples.html
22+
:text-align: center
23+
:class-title: pyansys-card-title
24+
:margin: 2 2 0 0
25+
1926
.. grid-item-card:: PyAnsys Math
2027
:img-top: _static/thumbnails/pyansys-math.png
2128
:link: https://math.docs.pyansys.com/version/stable/examples/index.html

‎doc/source/index.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ it is now a collection of many Python packages for using Ansys products through
1313
user_guide
1414
api
1515
examples
16+
tools
1617

1718
.. grid:: 3
1819

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

2627
Pythonic interface to AEDT (Ansys Electronic Desktop)
2728

29+
.. grid-item-card:: PyAnsys Geometry
30+
:img-top: _static/thumbnails/pyansys-geometry.png
31+
:link: https://geometry.docs.pyansys.com/version/stable
32+
:text-align: center
33+
:class-title: pyansys-card-title
34+
:margin: 2 2 0 0
35+
36+
Pythonic interface to the Ansys Geometry service
37+
2838
.. grid-item-card:: PyAnsys Math
2939
:img-top: _static/thumbnails/pyansys-math.png
3040
:link: https://math.docs.pyansys.com/version/stable

‎doc/source/tools.rst‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
Other tools
2+
===========
3+
4+
Tooling libraries delivered with the **extra** target as well as other standalone tools
5+
that can be installed or used.
6+
7+
*******************
8+
Standalone projects
9+
*******************
10+
11+
.. grid:: 3
12+
13+
.. grid-item-card:: Ansys Python Manager
14+
:img-top: _static/thumbnails/ansys-python-manager.png
15+
:link: https://installer.docs.pyansys.com/version/stable
16+
:text-align: center
17+
:class-title: pyansys-card-title
18+
:margin: 2 2 0 0
19+
20+
Simple cross-platform QT application to install Python and PyAnsys packages
21+
22+
.. grid-item-card:: Ansys ``pre-commit`` hooks
23+
:img-top: _static/thumbnails/intro.png
24+
:link: https://pre-commit-hooks.docs.ansys.com/version/stable
25+
:text-align: center
26+
:class-title: pyansys-card-title
27+
:margin: 2 2 0 0
28+
29+
Ansys repository containing customized pre-commit hooks
30+
31+
.. grid-item-card:: Ansys Tools Repository Sync
32+
:img-top: _static/thumbnails/intro.png
33+
:link: https://ansys.github.io/ansys-tools-repo-sync/version/stable
34+
:text-align: center
35+
:class-title: pyansys-card-title
36+
:margin: 2 2 0 0
37+
38+
Ansys tool intended to synchronize the content of two different repositories
39+
40+
*****************
41+
Tooling libraries
42+
*****************
43+
44+
.. grid:: 3
45+
46+
.. grid-item-card:: Ansys Tools Path
47+
:img-top: _static/thumbnails/intro.png
48+
:link: https://path.tools.docs.pyansys.com/version/stable
49+
:text-align: center
50+
:class-title: pyansys-card-title
51+
:margin: 2 2 0 0
52+
53+
Library to locate Ansys products in a local machine
54+
55+
.. grid-item-card:: PyAnsys Tools Report
56+
:img-top: _static/thumbnails/intro.png
57+
:link: https://report.tools.docs.pyansys.com/version/stable/
58+
:text-align: center
59+
:class-title: pyansys-card-title
60+
:margin: 2 2 0 0
61+
62+
Tool for reporting your Python environment's package versions and hardware resources in a standardized way
63+
64+
.. grid-item-card:: PyAnsys Tools Versioning
65+
:img-top: _static/thumbnails/intro.png
66+
:link: https://versioning.tools.docs.pyansys.com/version/stable/
67+
:text-align: center
68+
:class-title: pyansys-card-title
69+
:margin: 2 2 0 0
70+
71+
Tool for backwards and forwards server support
72+
73+
.. grid-item-card:: PyAnsys Units
74+
:img-top: _static/thumbnails/intro.png
75+
:link: https://units.docs.pyansys.com/version/stable/
76+
:text-align: center
77+
:class-title: pyansys-card-title
78+
:margin: 2 2 0 0
79+
80+
Pythonic interface for units, unit systems, and unit conversions

0 commit comments

Comments
 (0)