Skip to main content

A python toolkit for geoscience researchers and students

Project description

MinexPy

MinexPy is a practical toolkit for geoscience researchers and students who are learning how to solve real geoscientific problems with Python—or who want a deeper, more structured understanding of which Python tools fit which geoscience tasks.

Even though modern AI tools can help you prototype quickly, it’s still hard for beginners to answer questions like:

  • Which library should I use for this exact problem?
  • What’s the “standard” workflow in geoscience when using Python?
  • How do I discover reliable tools without getting lost in hundreds of packages?

MinexPy aims to reduce that confusion by providing curated, beginner-friendly building blocks and sensible combinations of widely-used libraries, so you can focus more on the science and less on setup and guesswork.


Installation

Install with pip:

pip install minexpy

How to use

MinexPy provides both a Python API and a command-line interface.

Python API

Like most Python packages, you install it and import what you need:

import minexpy.stats as mstats
from minexpy import (
    StatisticalAnalyzer,
    describe,
    pearson_correlation,
    spearman_correlation,
    plot_histogram,
)

Example: Correlation + Visualization

import numpy as np
from minexpy.correlation import pearson_correlation, spearman_correlation
from minexpy.statviz import plot_histogram

zn = np.array([45.2, 52.3, 38.7, 61.2, 49.8, 55.1])
cu = np.array([12.5, 15.3, 11.2, 18.4, 14.1, 16.0])

print(pearson_correlation(zn, cu))
print(spearman_correlation(zn, cu))

fig, ax = plot_histogram(zn, bins=10, scale="linear", xlabel="Zn (ppm)")

Command-Line Interface

After installation, use the minexpy command for quick access to documentation and examples:

# Show help and available functions
minexpy

# Show practical code examples you can copy
minexpy demo

# Open documentation in browser
minexpy docs

# Show package information
minexpy info

Documentation and examples will expand over time as modules are added.


Roadmap / TODO

Want to contribute? Here are some high-impact areas to work on:

  • Mapping module for geological, geochemical, and geophysical data

  • Interpolation methods commonly used in geosciences (e.g., minimum curvature, triangulation, and others)

  • AOI extraction from large satellite imagery (selecting/cropping a region of interest from big scenes)


Contributing

Contributions are welcome—especially examples, notebooks/markdown tutorials, and new modules that follow the project’s goals:

  • beginner-friendly

  • practical workflows

  • clear and detailed documentation using NumPy's docstrings guidelines

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

minexpy-0.1.2.tar.gz (44.2 kB view details)

Uploaded Source

Built Distribution

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

minexpy-0.1.2-py3-none-any.whl (49.2 kB view details)

Uploaded Python 3

File details

Details for the file minexpy-0.1.2.tar.gz.

File metadata

  • Download URL: minexpy-0.1.2.tar.gz
  • Upload date:
  • Size: 44.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.11

File hashes

Hashes for minexpy-0.1.2.tar.gz
Algorithm Hash digest
SHA256 10dc3616de653b0509ae2e57a843bedd31d72ea0ee6ec5c30110a5cdc9b0004a
MD5 7d156084d71f059e4f2756b23b52156b
BLAKE2b-256 dc19e4f2f75be9d523640fedaec1c1aa0ad5de41f856cc044d94b71882760775

See more details on using hashes here.

File details

Details for the file minexpy-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: minexpy-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 49.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.11

File hashes

Hashes for minexpy-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 26b8a65f0957352990b43d02a58d15908d66785f511c108dcdabef9995b708d7
MD5 93299cfc171398862689fcf013b42174
BLAKE2b-256 ec92f14d01e3924ec1f5a1ef34cb26e336286488c2cf99cd24a198cb336c11c2

See more details on using hashes here.

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