Metadata-Version: 2.4
Name: auxi-mpp
Version: 2.8.0
Summary: `auxi` provides tools to help users do calculations for metallurgical process engineering. `auxi-mpp` provides tools for calculating material physical properties.
Author-email: Johan Zietsman <johan.zietsman@ex-mente.co.za>, Hanno Muire <hanno.muire@ex-mente.co.za>, Stefan Koning <stefan.koning@ex-mente.co.za>
Maintainer-email: Stefan van der Merwe <stefan.vandermerwe@ex-mente.co.za>, Thys Nortje <thys.nortje@ex-mente.co.za>
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: Console
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: auxi-chemistry>=2.7.0
Requires-Dist: polars>=1.21.0
Requires-Dist: pybtex>=0.25.1
Requires-Dist: pytest>=8.3.5
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: scipy>=1.16.1
Requires-Dist: sphinx-design>=0.6.1
Requires-Dist: sphinx-tabs>=3.4.7
Dynamic: license-file

# auxi-mpp

[![PyPI version](https://img.shields.io/pypi/v/auxi-mpp)](https://pypi.org/project/auxi-mpp/)
[![CI](https://gitlab.com/auxi-oss/auxi-mpp/badges/main/pipeline.svg)](https://gitlab.com/auxi-oss/auxi-mpp/-/blob/main/.gitlab-ci.yml?ref_type=heads)
[![License](https://img.shields.io/badge/License-MIT-blue)](https://opensource.org/license/MIT)
[![PyPI Downloads](https://static.pepy.tech/personalized-badge/auxi-mpp?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/auxi-mpp)

`auxi` provides tools to help users do calculations for metallurgical process engineering.
`auxi-mpp` provides tools for calculating material physical properties.

## Installation

The following command will install the latest version of `auxi-mpp` from the [Python Package Index (PyPI)](https://pypi.org/project/auxi-mpp/).
You will need a working installation of Python and `pip` to run this command.

```bash
pip install -U auxi-mpp
```

auxi-mpp runs in Python 3.12 and higher.

## Documentation

For full documentation on how to use `auxi-mpp`, as well as for downloading the `auxi-mpp` Theory Manual, please refer to the [auxi-mpp documentation](https://auxi-oss.gitlab.io/auxi-mpp/).

## Feedback

We encourage you to give us your feedback on `auxi-mpp`!
Your insights are crucial for us to understand what's working well, what needs improvement, and how we can better support your workflow.
We've put together a brief [feedback form](https://forms.gle/3Kakqid29F1WZcwt8) that should only take a few minutes to complete.

## Contributing

We welcome contributions!
Please refer to the [contributors guide](https://gitlab.com/auxi-oss/gitlab-profile/-/blob/main/CONTRIBUTING.md?ref_type=heads) for more information.

## How to Cite

If you use `auxi-mpp` in your research or work, please cite it as follows.

**APA Style**

Koning, S. L., Muire, H., Zhu, M., Zietsman, J.H. & Nortje, M.N. (2026). auxi-mpp (Version 2.8.0) [Computer software]. https://gitlab.com/auxi-oss/auxi-mpp
