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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ it is now a collection of many Python packages for using Ansys products through
user_guide
api
examples
tools
tools/index

.. grid:: 3

Expand Down
80 changes: 0 additions & 80 deletions doc/source/tools.rst

This file was deleted.

34 changes: 34 additions & 0 deletions doc/source/tools/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Other tools
===========

Standalone projects, tooling libraries and toolkits related to the PyAnsys ecosystem.

.. grid:: 1

.. grid-item-card:: :octicon:`package` Standalone projects
:link: standalone/index
:link-type: doc
:margin: 2 2 0 0

Standalone projects to exploit the full potential of the PyAnsys ecosystem

.. grid-item-card:: :octicon:`tools` Tooling libraries
:link: libraries/index
:link-type: doc
:margin: 2 2 0 0

Additional libraries delivered with the ``tools`` target of the PyAnsys metapackage

.. grid-item-card:: :octicon:`gear` Toolkits
:link: toolkits/index
:link-type: doc
:margin: 2 2 0 0

Toolkits built on top of PyAnsys libraries for specific purposes.

.. toctree::
:hidden:

standalone/index
libraries/index
toolkits/index
40 changes: 40 additions & 0 deletions doc/source/tools/libraries/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
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
120 changes: 120 additions & 0 deletions doc/source/tools/standalone/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
Standalone projects
===================

.. contents::

General purpose
---------------

.. 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:: PyAnsys Cheat Sheets
:img-top: ../../_static/thumbnails/pyansys-cheat-sheets.png
:link: https://cheatsheets.docs.pyansys.com/
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

PyAnsys cheat sheets for different libraries as quick reference guides

Repository management
---------------------

.. grid:: 3

.. grid-item-card:: Ansys Repository Templates
:img-top: ../../_static/thumbnails/intro.png
:link: https://templates.ansys.com/version/stable
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Ansys tool for creating new projects according to Ansys guidelines

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

Collection of GitHub Workflows to be reused by projects in the Ansys ecosystem

.. 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


Artificial intelligence
-----------------------

.. grid:: 3

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

Python development tool for leveraging the power of OpenAI to automatically
generate suggestions for improving GitHub pull requests


Documentation
-------------

.. grid:: 3

.. grid-item-card:: Ansys Sphinx Theme
:img-top: ../../_static/thumbnails/intro.png
:link: https://sphinxdocs.ansys.com/version/stable
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Extension of the popular `PyData Sphinx theme <https://github.com/pydata/pydata-sphinx-theme>`_
that is used by `numpy <https://numpy.org/doc/stable/>`_, `pandas <https://pandas.pydata.org/docs/>`_,
`pyvista <https://docs.pyvista.org>`_, and many more scientific Python packages

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

Enhanced Python API to Meilisearch

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

Python development tool for leveraging the power of OpenAI to automatically
generate suggestions for improving GitHub pull requests
18 changes: 18 additions & 0 deletions doc/source/tools/toolkits/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
PyAnsys toolkits
================

.. contents::

PyAEDT toolkits
---------------

.. grid:: 3

.. grid-item-card:: PyAEDT Antenna Toolkit
:img-top: ../../_static/thumbnails/intro.png
:link: https://aedt.antenna.toolkit.docs.pyansys.com/version/stable
:text-align: center
:class-title: pyansys-card-title
:margin: 2 2 0 0

Python wrapper for modeling antennas using Ansys Electronics Desktop (AEDT) via PyAEDT
1 change: 1 addition & 0 deletions doc/styles/Vocab/ANSYS/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ PyPIM
Granta MI BoM Analytics
metapackage
PyTwin
toolkits