Skip to main content

Petrology tools

Project description

Lydwhitt_tools

A collection of functions and tools I have developed and find useful during my volcanology PhD.

Whilst I have a lot of tools and functions on my computer that I use regularly, I haven't yet put them all in a place to help others. There are a lot of very simple tasks that waste time, which I've created tools to complete, and I will be adding them to this repository over time.

I started collating this in August 2025 — so bear with me whilst I get it going!


Install

pip install lydwhitt-tools


Quickstart

Here’s the simplest way to run the geochemical filter tool: import pandas as pd import lydwhitt_tools as lwt Load your geochemical dataset df = pd.read_csv("my_data.csv") Apply the filter (defaults: total_perc=96, percentiles=(98, 98)) filtered_df = lwt.geochemical_filter(df, phase="Cpx") print(filtered_df.head())


Detailed Usage

The geochemical_filter function filters geochemical datasets using the Mahalanobis distance method in two passes.

Function signature: lwt.geochemical_filter(df, phase, total_perc=None, percentiles=None)

Parameters:

  • phase (str) – e.g., "Cpx", "Plg", "Liq". Must match the suffix used after oxide wt% values in your dataset.
  • total_perc (float, optional) – Minimum total oxide percentage allowed. Defaults to 96.
  • percentiles (int, float, or tuple, optional) – Percentile cutoffs for Pass 1 and Pass 2.
    • Single value applies to both passes (e.g., percentiles=98).
    • Tuple gives different cutoffs for each pass (e.g., percentiles=(95, 99)).

Example: Use different percentiles for each pass filtered_df = lwt.geochemical_filter(df, phase="Plg", total_perc=97, percentiles=(95, 99))


Output

The function returns the filtered DataFrame, including flags for each pass:

  • Mahalanobis – Mahalanobis distance for each row in the given pass.
  • P1_Outlier – Boolean flag indicating if the row was an outlier in Pass 1.
  • P2_Outlier – Boolean flag indicating if the row was an outlier in Pass 2.

Features Coming Soon

This repository will grow to include: -formula recalculations for different phases -simple plotting frameworks -data re-oragnisation tools for popular gothermobarometry packages


License

This project is licensed under the MIT License.

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

lydwhitt_tools-0.1.8.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lydwhitt_tools-0.1.8-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file lydwhitt_tools-0.1.8.tar.gz.

File metadata

  • Download URL: lydwhitt_tools-0.1.8.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lydwhitt_tools-0.1.8.tar.gz
Algorithm Hash digest
SHA256 038f76a2d73d2ef66456ebf716315a676f51aa76427be901b7afcc40ea24688a
MD5 e30b3f7425649d106b0b64f7145ca95d
BLAKE2b-256 a221f1cf62a65f8c6ff0b651892c54f74a059c2146467c3b93d545048416c68a

See more details on using hashes here.

Provenance

The following attestation bundles were made for lydwhitt_tools-0.1.8.tar.gz:

Publisher: publish.yml on lydwhitt7/Lydwhitt_tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lydwhitt_tools-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: lydwhitt_tools-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lydwhitt_tools-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7aff9dd19849c2e4bf5574f951a708d6acf4cda28c92fc83225a365010269a5e
MD5 ec0d870f75ef11f55d1bd264df1b5c18
BLAKE2b-256 e2167526b82c249f92e2280bbdea6a1e2cb09d5bbb3c1ac3de0682846a45ab9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for lydwhitt_tools-0.1.8-py3-none-any.whl:

Publisher: publish.yml on lydwhitt7/Lydwhitt_tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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