MassComposition
MassComposition is a python package that allows Geoscientists and Metallurgists to easily work with, and visualise mass-compositional data.
Mass Composition in this context is just that - Mass and Composition. It is not Compositional Data Analysis (CoDA), since here we care more about mathematical operations like weight averaging and technically correct mathematical operations. Of course, we also need to manage moisture correctly - chemical composition is reported on a dry basis and moisture on a wet basis.
The package not only supports individual MassComposition, but collections of objects that are mathematically related in a Directional Graph (a.k.a. network or flowsheet).
Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of the mass-composition python package.
- You have a Windows/Linux/Mac machine.
- You have read the docs.
Installing MassComposition
To install MassComposition, follow these steps:
pip install mass-composition -e .[viz,network]
Or, if poetry is more your flavour.
poetry add "mass-composition[viz,network]"
Using MassComposition
To use MassComposition, follow these steps:
There are some basic requirements that the incoming DataFrame must meet. We'll use a sample DataFrame here.
df_data: pd.DataFrame = sample_data()
Create the object
obj_mc: MassComposition = MassComposition(df_data)
It is then trivial to calculate the weight average aggregate of the dataset.
obj_mc.aggregate()
Multiple composition analytes can be viewed in a single interactive parallel coordinates plot.
obj_mc: MassComposition = MassComposition(df_data.reset_index().set_index(['DHID', 'interval_from', 'interval_to']),
name=name)
fig: Figure = obj_mc.plot_parallel(color='Fe')
fig
Network visualisations and other plots are interactive.
For full examples, see the gallery.
Contributing to MassComposition
To contribute to MassComposition, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git commit -m '<commit_message>' - Push to the original branch:
git push origin mass-composition - Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
Contributors
This project is still in its infancy, but I'm keen to work with contributors.
Contact
If you want to contact me you can reach me at your_email@address.com.
License
This project uses the following license: MIT.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mass_composition-0.6.0.tar.gz.
File metadata
- Download URL: mass_composition-0.6.0.tar.gz
- Upload date:
- Size: 62.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.0.0 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e969ac513c367915de553c50b433e9c789bfa869dd951556e2de282df5d0902
|
|
| MD5 |
0b4263294f0a96826b44bb0aa04e7c55
|
|
| BLAKE2b-256 |
1a97c81d35abb5808ddba5bd048542dd4a97f7ab63286f75e8f772fadbedca10
|
File details
Details for the file mass_composition-0.6.0-py3-none-any.whl.
File metadata
- Download URL: mass_composition-0.6.0-py3-none-any.whl
- Upload date:
- Size: 69.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.0.0 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa4c575094cf6c88c684485e845e37a80541a3e120d284f3ac93276884001d35
|
|
| MD5 |
f5c0b6eab20d0d4c2bc0caacab010f6a
|
|
| BLAKE2b-256 |
0605cfa746cb2e217b6a04d372aa92c1b93bcbe500fca5007f9b404db9294072
|
