PyMaterials Manager

PyMaterials Manager is a Python package for unifying material management across the Ansys portfolio.

PyMaterials Manager is currently a proof of concept, expect things to break. It currently provides the following features:

• It defines a Material Object that can have different material models
• The supported material models can be read from a running PyMAPDL instance
• The supported material models can written to a running PyMAPDL / pyFluent instance
• Some supported material models can be read from a MatML XML file
• Some supported material models can be written to a MatML XML file

The following material models are supported:

• pyMAPDL

  • Simple constant material properties
  • Piecewise linear material properties
  • Polynomial material properties
  • Anisotropic Elasticity

• pyFluent

  • Simple constant material properties
  • Ideal Gas properties

Installation

Install the ansys-materials-manager package with this code:

pip install ansys-materials-manager

Alternatively, clone and install this package with this code:

git clone https://github.com/ansys/pymaterials-manager
cd pymaterials-manager
pip install .

Testing

This project takes advantage of tox. This tool is used to automate common development tasks (similar to Makefile), but it is oriented towards Python development.

Use tox

tox uses environments, which are similar to Makefile rules, to make it highly customizable. In fact, this tool creates its own virtual environment so that anything being tested is isolated from the project to guarantee the project's integrity.

Descriptions follow of some of the most widely used environments:

• tox -e style: Checks the code style of your project.
• tox -e py: Runs your test suite.
• tox -e doc: Builds the documentation of your project.

Perform raw testing

If required, you can call style commands (such as black, isort, and flake8) or unit testing commands (such as pytest) from the command line. However, calling these commands does not guarantee that your project is being tested in an isolated environment, which is the reason why tools like tox exist.

Use pre-commit

The style checks take advantage of pre-commit. Developers are not forced but encouraged to install this tool by running this command:

python -m pip install pre-commit && pre-commit install

Every time you stage some changes and try to commit them, pre-commit only allows them to be committed if all defined hooks succeed.

Documentation and issues

For comprehensive information on PyMaterials Manager, see the latest release documentation. On the PyMaterials Manager Issues page, you can create issues to submit questions, report bugs, and request new features. This is the best place to post questions and code.

Distribution

If you want to create either source or wheel files, start by installing poetry and then executing the build module. To install poetry you should use the pipx installation method in the poetry documentation.

poetry install
poetry build
twine check ./dist