Skip to main content

Tools for the geometallurgist

Project description

Geometallurgy

PyPI Run Tests Publish Docs

Geometallurgy is a python package that allows geoscientists and metallurgists to easily work with, and visualise mass-compositional data.

Geoscientific disciples, like Metallurgy, Geometallurgy, Geology, and Mining Engineering, rely on the analysis of data based on mass, moisture and chemistry. The data is collected from drill-holes, samples, and process streams. The data is used to model the behaviour of the material in the ground, and the material as it is processed.

The Geometallurgy package supports the geometallurgical workflow from drill-hole planning and data analysis, sample fractionation and mass balanced process simulation, through to 3D block model visualisation. The is designed to handle large datasets and provide the necessary visualisations to support the workflow. Plots are generally interactive to maximise context and insight. Assurance of data integrity is a key objective.

The package not only supports individual Samples, but collections of objects that are mathematically related in a Directional Graph (a.k.a. network or flowsheet).

This package is a rewrite of the mass-composition package (based on pandas only instead of pandas/xarray).

example plot

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 Geometallurgy

To install Geometallurgy, follow these steps:

pip install geometallurgy

Or, if poetry is more your flavour.

poetry add "geometallurgy"

Using Geometallurgy

To use GeoMetallurgy to create a Sample object, follow these steps:

There are some basic requirements that the incoming DataFrame must meet. We'll use a sample DataFrame here.

df_data = sample_data()

Create the object

sample = Sample(df_data)

It is then trivial to calculate the weight average aggregate of the dataset.

sample.aggregate()

Multiple composition analytes can be viewed in a single interactive parallel coordinates plot.

sample = Sample(df_data.reset_index().set_index(['DHID', 'interval_from', 'interval_to']),
                name=name)

fig = sample.plot_parallel(color='Fe')
fig

Network visualisations and other plots are interactive.

For full examples, see the gallery.

License

This project uses the following license: MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geometallurgy-0.4.0.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

geometallurgy-0.4.0-py3-none-any.whl (72.5 kB view details)

Uploaded Python 3

File details

Details for the file geometallurgy-0.4.0.tar.gz.

File metadata

  • Download URL: geometallurgy-0.4.0.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for geometallurgy-0.4.0.tar.gz
Algorithm Hash digest
SHA256 fcd6e3ec95dadf8e7d7b27feec5f6c3be6fb5dff25b629c4dec9d895b3ae696b
MD5 855000884070eb49c08102f032c8e62f
BLAKE2b-256 b9929c52f7d8b017c7ada751cd8311b5cf150f3a0098fe7e004d084b9db8e120

See more details on using hashes here.

File details

Details for the file geometallurgy-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for geometallurgy-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b189a93266ea0ea153c84d486ca0da0f2050b650d34036137507584d5fcb0ffa
MD5 9e1236d7a6d18fd23dedc2bd3b8d0be9
BLAKE2b-256 3d1ad7cb3b89fc3df9f96b4bb4ba0cdf1f4d11d2a0e6b68a207f9db56e5655ff

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page