Metadata-Version: 2.1
Name: ansys-math-core
Version: 0.1.0
Summary: A Python wrapper for PyAnsys Math libraries.
Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Dist: ansys-mapdl-core>=0.64.0
Requires-Dist: pyansys-tools-versioning>=0.3.3
Requires-Dist: numpy>=1.14.0
Requires-Dist: importlib-metadata>=4.0,<5; python_version<='3.8'
Requires-Dist: Sphinx==5.3.0 ; extra == "doc"
Requires-Dist: ansys-mapdl-core==0.64.0 ; extra == "doc"
Requires-Dist: ansys-mapdl-reader==0.52.11 ; extra == "doc"
Requires-Dist: ansys-sphinx-theme==0.9.5 ; extra == "doc"
Requires-Dist: jupyter_sphinx==0.4.0 ; extra == "doc"
Requires-Dist: jupyterlab==3.6.2 ; extra == "doc"
Requires-Dist: numpydoc==1.5.0 ; extra == "doc"
Requires-Dist: pandas==1.5.3 ; extra == "doc"
Requires-Dist: pypandoc==1.11 ; extra == "doc"
Requires-Dist: pytest-sphinx==0.5.0 ; extra == "doc"
Requires-Dist: pyvista==0.38.5 ; extra == "doc"
Requires-Dist: sphinx-autobuild==2021.3.14 ; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints==1.22 ; extra == "doc"
Requires-Dist: sphinx-copybutton==0.5.1 ; extra == "doc"
Requires-Dist: sphinx-notfound-page==0.8.3 ; extra == "doc"
Requires-Dist: sphinx-gallery==0.12.2 ; extra == "doc"
Requires-Dist: vtk==9.2.6 ; extra == "doc"
Requires-Dist: ansys-mapdl-core==0.64.0 ; extra == "tests"
Requires-Dist: scipy==1.10.1 ; extra == "tests"
Requires-Dist: pyansys-tools-report==0.5.0 ; extra == "tests"
Requires-Dist: pytest==7.2.2 ; extra == "tests"
Requires-Dist: pytest-cov==4.0.0 ; extra == "tests"
Requires-Dist: pytest-rerunfailures==11.1.2 ; extra == "tests"
Requires-Dist: pyvista==0.38.5 ; extra == "tests"
Requires-Dist: vtk==9.2.6 ; extra == "tests"
Project-URL: Documentation, https://math.docs.pyansys.com
Project-URL: Homepage, https://github.com/pyansys/ansys-math/
Project-URL: Source, https://github.com/pyansys/ansys-math
Project-URL: Tracker, https://github.com/pyansys/ansys-math/issues
Provides-Extra: doc
Provides-Extra: tests

PyAnsys Math
============

|pyansys| |pypi| |PyPIact| |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/pyansys-math-core.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/ansys-math-core/

.. |PyPIact| image:: https://img.shields.io/pypi/dm/pyansys-math-core.svg?label=PyPI%20downloads
   :target: https://pypi.org/project/ansys-math-core/

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

.. |GH-CI| image:: https://github.com/pyansys/pyansys-math/actions/workflows/ci_cd.yml/badge.svg
   :target: https://github.com/pyansys/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


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 <https://www.ansys.com/>`_.



Installation
------------

For users
~~~~~~~~~
The ``ansys.math.core`` package currently supports Python 3.7 through
Python 3.10 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 <https://github.com/pyansys/pyansys-math.git>`_ package
with this command:

.. code::

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



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

.. code::

   git clone https://github.com/pyansys/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:: python

    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.

