Skip to content

Commit 10cd817

Browse files
authored
feat: including new tools and better organization (#362)
* feat: reorg tools section + new tools * fix: pre-commit * feat: accepted word * feat: add reviewer-bot project * feat: improve layout * feat: final edits
1 parent 990ce4b commit 10cd817

File tree

8 files changed

+214
-81
lines changed

8 files changed

+214
-81
lines changed
532 KB
Loading

doc/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +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
16+
tools/index
1717

1818
.. grid:: 3
1919

doc/source/tools.rst

Lines changed: 0 additions & 80 deletions
This file was deleted.

doc/source/tools/index.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Other tools
2+
===========
3+
4+
Standalone projects, tooling libraries and toolkits related to the PyAnsys ecosystem.
5+
6+
.. grid:: 1
7+
8+
.. grid-item-card:: :octicon:`package` Standalone projects
9+
:link: standalone/index
10+
:link-type: doc
11+
:margin: 2 2 0 0
12+
13+
Standalone projects to exploit the full potential of the PyAnsys ecosystem
14+
15+
.. grid-item-card:: :octicon:`tools` Tooling libraries
16+
:link: libraries/index
17+
:link-type: doc
18+
:margin: 2 2 0 0
19+
20+
Additional libraries delivered with the ``tools`` target of the PyAnsys metapackage
21+
22+
.. grid-item-card:: :octicon:`gear` Toolkits
23+
:link: toolkits/index
24+
:link-type: doc
25+
:margin: 2 2 0 0
26+
27+
Toolkits built on top of PyAnsys libraries for specific purposes.
28+
29+
.. toctree::
30+
:hidden:
31+
32+
standalone/index
33+
libraries/index
34+
toolkits/index
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Tooling libraries
2+
=================
3+
4+
.. grid:: 3
5+
6+
.. grid-item-card:: Ansys Tools Path
7+
:img-top: ../../_static/thumbnails/intro.png
8+
:link: https://path.tools.docs.pyansys.com/version/stable
9+
:text-align: center
10+
:class-title: pyansys-card-title
11+
:margin: 2 2 0 0
12+
13+
Library to locate Ansys products in a local machine
14+
15+
.. grid-item-card:: PyAnsys Tools Report
16+
:img-top: ../../_static/thumbnails/intro.png
17+
:link: https://report.tools.docs.pyansys.com/version/stable
18+
:text-align: center
19+
:class-title: pyansys-card-title
20+
:margin: 2 2 0 0
21+
22+
Tool for reporting your Python environment's package versions and hardware resources in a standardized way
23+
24+
.. grid-item-card:: PyAnsys Tools Versioning
25+
:img-top: ../../_static/thumbnails/intro.png
26+
:link: https://versioning.tools.docs.pyansys.com/version/stable
27+
:text-align: center
28+
:class-title: pyansys-card-title
29+
:margin: 2 2 0 0
30+
31+
Tool for backwards and forwards server support
32+
33+
.. grid-item-card:: PyAnsys Units
34+
:img-top: ../../_static/thumbnails/intro.png
35+
:link: https://units.docs.pyansys.com/version/stable
36+
:text-align: center
37+
:class-title: pyansys-card-title
38+
:margin: 2 2 0 0
39+
40+
Pythonic interface for units, unit systems, and unit conversions
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
Standalone projects
2+
===================
3+
4+
.. contents::
5+
6+
General purpose
7+
---------------
8+
9+
.. grid:: 3
10+
11+
.. grid-item-card:: Ansys Python Manager
12+
:img-top: ../../_static/thumbnails/ansys-python-manager.png
13+
:link: https://installer.docs.pyansys.com/version/stable
14+
:text-align: center
15+
:class-title: pyansys-card-title
16+
:margin: 2 2 0 0
17+
18+
Simple cross-platform QT application to install Python and PyAnsys packages
19+
20+
.. grid-item-card:: PyAnsys Cheat Sheets
21+
:img-top: ../../_static/thumbnails/pyansys-cheat-sheets.png
22+
:link: https://cheatsheets.docs.pyansys.com/
23+
:text-align: center
24+
:class-title: pyansys-card-title
25+
:margin: 2 2 0 0
26+
27+
PyAnsys cheat sheets for different libraries as quick reference guides
28+
29+
Repository management
30+
---------------------
31+
32+
.. grid:: 3
33+
34+
.. grid-item-card:: Ansys Repository Templates
35+
:img-top: ../../_static/thumbnails/intro.png
36+
:link: https://templates.ansys.com/version/stable
37+
:text-align: center
38+
:class-title: pyansys-card-title
39+
:margin: 2 2 0 0
40+
41+
Ansys tool for creating new projects according to Ansys guidelines
42+
43+
.. grid-item-card:: Ansys GitHub Actions
44+
:img-top: ../../_static/thumbnails/intro.png
45+
:link: https://actions.docs.ansys.com/version/stable
46+
:text-align: center
47+
:class-title: pyansys-card-title
48+
:margin: 2 2 0 0
49+
50+
Collection of GitHub Workflows to be reused by projects in the Ansys ecosystem
51+
52+
.. grid-item-card:: Ansys ``pre-commit`` Hooks
53+
:img-top: ../../_static/thumbnails/intro.png
54+
:link: https://pre-commit-hooks.docs.ansys.com/version/stable
55+
:text-align: center
56+
:class-title: pyansys-card-title
57+
:margin: 2 2 0 0
58+
59+
Ansys repository containing customized pre-commit hooks
60+
61+
.. grid-item-card:: Ansys Tools Repository Sync
62+
:img-top: ../../_static/thumbnails/intro.png
63+
:link: https://ansys.github.io/ansys-tools-repo-sync/version/stable
64+
:text-align: center
65+
:class-title: pyansys-card-title
66+
:margin: 2 2 0 0
67+
68+
Ansys tool intended to synchronize the content of two different repositories
69+
70+
71+
Artificial intelligence
72+
-----------------------
73+
74+
.. grid:: 3
75+
76+
.. grid-item-card:: Reviewer Bot
77+
:img-top: ../../_static/thumbnails/intro.png
78+
:link: https://review-bot.docs.pyansys.com/version/stable
79+
:text-align: center
80+
:class-title: pyansys-card-title
81+
:margin: 2 2 0 0
82+
83+
Python development tool for leveraging the power of OpenAI to automatically
84+
generate suggestions for improving GitHub pull requests
85+
86+
87+
Documentation
88+
-------------
89+
90+
.. grid:: 3
91+
92+
.. grid-item-card:: Ansys Sphinx Theme
93+
:img-top: ../../_static/thumbnails/intro.png
94+
:link: https://sphinxdocs.ansys.com/version/stable
95+
:text-align: center
96+
:class-title: pyansys-card-title
97+
:margin: 2 2 0 0
98+
99+
Extension of the popular `PyData Sphinx theme <https://github.com/pydata/pydata-sphinx-theme>`_
100+
that is used by `numpy <https://numpy.org/doc/stable/>`_, `pandas <https://pandas.pydata.org/docs/>`_,
101+
`pyvista <https://docs.pyvista.org>`_, and many more scientific Python packages
102+
103+
.. grid-item-card:: PyMeilisearch
104+
:img-top: ../../_static/thumbnails/intro.png
105+
:link: https://pymeilisearch.docs.ansys.com/version/stable
106+
:text-align: center
107+
:class-title: pyansys-card-title
108+
:margin: 2 2 0 0
109+
110+
Enhanced Python API to Meilisearch
111+
112+
.. grid-item-card:: PyConverter-XML2Py
113+
:img-top: ../../_static/thumbnails/intro.png
114+
:link: https://review-bot.docs.pyansys.com/version/stable
115+
:text-align: center
116+
:class-title: pyansys-card-title
117+
:margin: 2 2 0 0
118+
119+
Python development tool for leveraging the power of OpenAI to automatically
120+
generate suggestions for improving GitHub pull requests
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
PyAnsys toolkits
2+
================
3+
4+
.. contents::
5+
6+
PyAEDT toolkits
7+
---------------
8+
9+
.. grid:: 3
10+
11+
.. grid-item-card:: PyAEDT Antenna Toolkit
12+
:img-top: ../../_static/thumbnails/intro.png
13+
:link: https://aedt.antenna.toolkit.docs.pyansys.com/version/stable
14+
:text-align: center
15+
:class-title: pyansys-card-title
16+
:margin: 2 2 0 0
17+
18+
Python wrapper for modeling antennas using Ansys Electronics Desktop (AEDT) via PyAEDT

doc/styles/Vocab/ANSYS/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ PyPIM
1717
Granta MI BoM Analytics
1818
metapackage
1919
PyTwin
20+
toolkits

0 commit comments

Comments
 (0)