minplascalc

minplascalc - LTE plasma calculations

https://github.com/quinnreynolds/minplascalc

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (19.0%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

minplascalc - LTE plasma calculations

Basic Info

Host: GitHub
Owner: quinnreynolds
License: gpl-3.0
Language: Python
Default Branch: main
Homepage:
Size: 6.26 MB

Statistics

Stars: 8
Watchers: 1
Forks: 1
Open Issues: 10
Releases: 4

Created over 7 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog License Citation

README.rst

README
======

.. image:: https://github.com/quinnreynolds/minplascalc/actions/workflows/on-push.yml/badge.svg
    :target: https://github.com/quinnreynolds/minplascalc/actions/workflows/on-push.yml/badge.svg

.. image:: https://raw.githubusercontent.com/quinnreynolds/minplascalc/coverage-badge/coverage.svg?raw=true
    :target: https://raw.githubusercontent.com/quinnreynolds/minplascalc/coverage-badge/coverage.svg?raw=true


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*


What is this repository for?
----------------------------

* 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 `_.


Quick start
-----------

* Simply install the package with ``pip install minplascalc``.
* You should now be able to run the example scripts in the ``examples``
  directory.
* The package is still in development, so expect bugs and changes.


Documentation
-------------

A full set of documentation is available online at
`https://quinnreynolds.github.io/minplascalc/ `_.


Workflow for developers/contributors
------------------------------------

* 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.13`` to create a virtual environment at ``.venv``,
  with ``python 3.13`` and 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:

1. Update dependencies with ``just update-env``.
2. Run quality assurance checks (code linting) checks with ``just qa``.
3. Run type checks with ``just type-check``.
4. Run unit tests with ``just tests``.
5. Run unit tests with coverage and generate a badge with ``just tests-cov``.
6. Build the documentation with ``just build-docs``.


Contribution guidelines
-----------------------

* Writing tests: TBC
* Code review: TBC
* Other guidelines: TBC


Who do I talk to?
-----------------

* quinnr@mintek.co.za


References
----------

* List of references are available at `the reference section `_.
* To add a reference, add a new entry to the ``docs/references/_bibliography.rst`` file.


Science behind the code
-----------------------

A brief overview of the science behind the code is available at
`the Background/Theory section `_.

Owner

Name: Quinn Reynolds
Login: quinnreynolds
Kind: user

Repositories: 2
Profile: https://github.com/quinnreynolds

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: minplascalc
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Quinn
    family-names: Reynolds
    email: quinnr@mintek.co.za
    affiliation: Mintek
    orcid: 'https://orcid.org/0000-0002-5196-8586'
  - given-names: Carl
    family-names: Sandrock
    email: carl.sandrock@gmail.com
  - given-names: Pierre-Antoine
    family-names: Goutier
    email: pierre-antoine.goutier@centralesupelec.fr
repository-code: 'https://github.com/quinnreynolds/minplascalc'
abstract: >-
  A simple set of tools in Python for doing calculations of
  thermal plasma compositions and thermophysical properties
  relevant to metallurgical problems.
keywords:
  - plasma physics
  - metallurgy
license: GPL-3.0
preferred-citation:
  type: article
  authors:
  - family-names: "Reynolds"
    given-names: "Q. G."
    orcid: "https://orcid.org/0000-0002-5196-8586"
  - family-names: "Bowman"
    given-names: "B."
  - family-names: "Erwee"
    given-names: "M. W."
  - family-names: "Geldenhuys"
    given-names: "I. J."
  - family-names: "Sandrock"
    given-names: "C."
  - family-names: "Venter"
    given-names: "G. A."
  - family-names: "Xakalashe"
    given-names: "B. S."
  - family-names: "Zietsman"
    given-names: "J."
  doi: "10.17159/2411-9717/758/2025"
  journal: "Journal of the Southern African Institute of Mining and Metallurgy"
  month: 3
  start: 129
  end: 144
  title: "Plasma soup for the pyrometallurgist’s soul"
  issue: 3
  volume: 125
  year: 2025

GitHub Events

Total

Create event: 11
Release event: 4
Issues event: 27
Watch event: 3
Delete event: 9
Member event: 1
Issue comment event: 61
Push event: 25
Pull request review comment event: 43
Pull request review event: 47
Pull request event: 22
Fork event: 1

Last Year

Create event: 11
Release event: 4
Issues event: 27
Watch event: 3
Delete event: 9
Member event: 1
Issue comment event: 61
Push event: 25
Pull request review comment event: 43
Pull request review event: 47
Pull request event: 22
Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 18
Total pull requests: 12
Average time to close issues: about 1 month
Average time to close pull requests: 1 day
Total issue authors: 3
Total pull request authors: 3
Average comments per issue: 1.44
Average comments per pull request: 1.67
Merged pull requests: 10
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 17
Pull requests: 12
Average time to close issues: 21 days
Average time to close pull requests: 1 day
Issue authors: 3
Pull request authors: 3
Average comments per issue: 1.24
Average comments per pull request: 1.67
Merged pull requests: 10
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

alchemyst (9)
quinnreynolds (6)
pag1pag (4)

Pull Request Authors

alchemyst (9)
pag1pag (4)
quinnreynolds (4)

Top Labels

Issue Labels

enhancement (1) minor (1) task (1) bug (1)

Pull Request Labels

enhancement (1)

Packages

Total packages: 1
Total downloads:
- pypi 28 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 4
Total maintainers: 1

pypi.org: minplascalc

A simple set of tools for doing calculations of thermal plasma compositions relevant to metallurgical problems using Python 3

Homepage: https://github.com/quinnreynolds/minplascalc
Documentation: https://minplascalc.readthedocs.io/
License: GPLv3
Latest release: 1.0.2
published 10 months ago

Versions: 4
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 28 Last month

Rankings

Dependent packages count: 9.5%

Average: 31.6%

Dependent repos count: 53.7%

Maintainers (1)

kittychunk