https://github.com/ansys/pyansys-math

A Python repository for mathematical libraries
https://github.com/ansys/pyansys-math

math python scientific-computing

Last synced: about 1 month ago
JSON representation

A Python repository for mathematical libraries

• Host: GitHub
• URL: https://github.com/ansys/pyansys-math
• Owner: ansys
• License: mit
• Created: 2022-12-07T09:10:09.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-09T09:32:32.000Z (about 1 month ago)
• Last Synced: 2025-04-10T09:07:30.442Z (about 1 month ago)
• Topics: math, python, scientific-computing
• Language: Python
• Homepage: https://math.docs.pyansys.com/
• Size: 7.16 MB
• Stars: 4
• Watchers: 5
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
PyAnsys Math

============

|pyansys| |pypi| |GH-CI| |codecov| |MIT| |black|

.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC

   :target: https://docs.pyansys.com/

   :alt: PyAnsys

.. |pypi| image:: https://img.shields.io/pypi/v/ansys-math-core.svg?logo=python&logoColor=white

   :target: https://pypi.org/project/ansys-math-core/

.. |codecov| image:: https://codecov.io/gh/ansys/pyansys-math/branch/main/graph/badge.svg

   :target: https://codecov.io/gh/ansys/pyansys-math

.. |GH-CI| image:: https://github.com/ansys/pyansys-math/actions/workflows/ci_cd.yml/badge.svg

   :target: https://github.com/ansys/pyansys-math/actions/workflows/ci_cd.yml

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg

   :target: https://opensource.org/licenses/MIT

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat

  :target: https://github.com/psf/black

  :alt: black

.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyansys-math/main.svg

   :target: https://results.pre-commit.ci/latest/github/ansys/pyansys-math/main

   :alt: pre-commit.ci status

PyAnsys Math is a Python repository holding Ansys mathematical libraries.

To use them, you must have a local installation of Ansys Mechanical APDL.

For information on getting a licensed copy of Ansys Mechanical APDL, visit

the `Ansys web site `_.

Installation

------------

For users

~~~~~~~~~

The ``ansys.math.core`` package currently supports Python 3.10 through

Python 3.12 on Windows, Mac OS, and Linux.

Install the latest package for use with this command:

.. code::

   pip install ansys-math-core

Alternatively, install the latest

`PyAnsys Math GitHub `_ package

with this command:

.. code::

   pip install git+https://github.com/ansys/pyansys-math.git

For developers

~~~~~~~~~~~~~~

For a local *development* version, install the latest package with:

.. code::

   git clone https://github.com/ansys/pyansys-math.git

   cd pyansys-math

   pip install -e .

Installing the development version allows you to edit the ``ansys-math-core``

package locally. The changes that you make are reflected in your setup

after restarting the Python kernel.

Verify your installation

------------------------

Check that you can start PyAnsys Math from Python by running this code:

.. code:: python3

    import ansys.math.core.math as pymath

    # Start PyAnsys Math.

    mm = pymath.AnsMath()

    print(mm)

If you see a response from the server, you can start using PyAnsys Math

as a service.

Ansys software requirements

---------------------------

You must have a copy of Ansys 2021 R1 or later installed locally.

.. note::

    The latest versions of Ansys provide significantly better support

    and features. PyAnsys Math is not supported on Ansys versions earlier than 2021 R1.