A simple set of tools in Python 3 for doing calculations of thermal plasma compositions relevant to metallurgical problems.
Quinn Reynolds, MINTEK Pyrometallurgy Division, 2018-present
- You're here because you want to calculate plasma compositions, thermodynamics, and physical and radiative properties. This package will do most of those things for LTE plasmas, to varying degrees of fidelity.
- Version v1.0.2.
- Simply install the package with
pip install minplascalc. - You should now be able to run the example scripts in the
examplesdirectory. - The package is still in development, so expect bugs and changes.
A full set of documentation is available online at https://quinnreynolds.github.io/minplascalc/.
- First, clone the repository. You'll get the package and some test drivers.
- Since we are using uv, install it by following instructions on their website.
- Run
uv sync --python 3.13to create a virtual environment at.venv, withpython 3.13and all the necessary dependencies. - To test if the package is working, run
uv run pytest. All tests should pass.
Next time, you just need to activate the virtual environment with
- (macOs and Linux)
source .venv/bin/activate.- (Windows)
.venv\Scripts\activate.
Before pushing to GitHub, run the following commands:
- Update dependencies with
just update-env. - Run quality assurance checks (code linting) checks with
just qa. - Run type checks with
just type-check. - Run unit tests with
just tests. - Run unit tests with coverage and generate a badge with
just tests-cov. - Build the documentation with
just build-docs.
- Writing tests: TBC
- Code review: TBC
- Other guidelines: TBC
- List of references are available at the reference section.
- To add a reference, add a new entry to the
docs/references/_bibliography.rstfile.
A brief overview of the science behind the code is available at the Background/Theory section.