https://github.com/ansys/pymapdl-examples
Repository holding examples for PyMAPDL
https://github.com/ansys/pymapdl-examples
Last synced: 5 months ago
JSON representation
Repository holding examples for PyMAPDL
- Host: GitHub
- URL: https://github.com/ansys/pymapdl-examples
- Owner: ansys
- License: mit
- Created: 2022-11-16T14:43:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T03:25:45.000Z (9 months ago)
- Last Synced: 2025-04-12T04:28:57.138Z (9 months ago)
- Language: Shell
- Homepage: https://examples.mapdl.docs.pyansys.com/
- Size: 16.8 MB
- Stars: 6
- Watchers: 6
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
PyMAPDL Examples
================
This repository holds examples for PyMAPDL.
Code Style
----------
Code style can be checked by running:
.. code-block:: text
tox -e style
Previous command will run `pre-commit`_ for checking code quality.
Documentation
-------------
Documentation can be rendered by running:
Windows
.. code-block:: text
tox -e doc-win
MacOS/Linux (requires make)
.. code-block:: text
tox -e doc-linux
The resultant HTML files can be inspected using your favorite web browser:
.. code-block:: text
.tox/doc_out_html/index.html
*Previous command will open the rendered documentation in the desired browser.*
.. LINKS AND REFERENCES
.. _black: https://github.com/psf/black
.. _flake8: https://flake8.pycqa.org/en/latest/
.. _isort: https://github.com/PyCQA/isort
.. _PyAnsys Developer's guide: https://dev.docs.pyansys.com/
.. _pre-commit: https://pre-commit.com/
.. _pytest: https://docs.pytest.org/en/stable/
.. _Sphinx: https://www.sphinx-doc.org/en/master/
.. _pip: https://pypi.org/project/pip/
.. _tox: https://tox.wiki/
.. _venv: https://docs.python.org/3/library/venv.html