Metadata-Version: 2.4
Name: boitata
Version: 0.6.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Rust
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Typing :: Typed
Requires-Dist: numpy>=1.26
Requires-Dist: anywidget>=0.9 ; extra == '3d'
Requires-Dist: matplotlib>=3.8 ; extra == 'all'
Requires-Dist: pandas>=2.2 ; extra == 'all'
Requires-Dist: polars>=1.4 ; extra == 'all'
Requires-Dist: pyarrow>=16 ; extra == 'all'
Requires-Dist: anywidget>=0.9 ; extra == 'all'
Requires-Dist: playwright>=1.45 ; extra == 'export'
Requires-Dist: matplotlib>=3.8 ; extra == 'plot'
Provides-Extra: 3d
Provides-Extra: all
Provides-Extra: export
Provides-Extra: plot
License-File: LICENSE
Summary: My Python tooling for day-to-day geostatistics
Keywords: geostatistics,kriging,variogram,simulation,mining,geology
Author: Gustavo Pretto Scholze
License-Expression: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Documentation, https://gstvschlz.github.io/boitata/
Project-URL: Homepage, https://github.com/gstvschlz/boitata
Project-URL: Issues, https://github.com/gstvschlz/boitata/issues
Project-URL: Repository, https://github.com/gstvschlz/boitata

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/gstvschlz/boitata/main/docs/assets/logo-animated-dark.svg">
    <img src="https://raw.githubusercontent.com/gstvschlz/boitata/main/docs/assets/logo-animated.svg" alt="boitatá" width="120">
  </picture>
</p>

<h1 align="center">boitatá</h1>

<p align="center">
  My Python tooling for day-to-day geostatistics.<br>
  <a href="https://gstvschlz.github.io/boitata/">Docs</a> ·
  <a href="https://gstvschlz.github.io/boitata/examples/01-first-steps/">Examples</a> ·
  <a href="https://gstvschlz.github.io/boitata/api/containers/">API</a>
</p>

<p align="center">
  <a href=""><img src="https://github.com/gstvschlz/boitata/actions/workflows/release.yml/badge.svg" alt="CI/CD status"></a>
  <a href=""><img src="https://github.com/gstvschlz/boitata/actions/workflows/test.yml/badge.svg" alt="Tests"></a>
  <a href="https://colab.research.google.com/github/gstvschlz/boitata/blob/main/notebooks/learn_00.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open in Colab"></a>
</p>

> boitatá is a guardian spirit of underground resources in Brazilian folklore.

`boitatá` holds the tools I use for resource work: drill hole checks, statistics, transforms, variograms, kriging, simulation and model checks.

## Install

```sh
pip install "boitata[all]"
```

Published on PyPI and imported as `boitata`. Wheels for Linux, macOS and Windows, Python ≥ 3.11.
Extras: `plot` (Matplotlib), `3d` (the notebook widget of `bt.plot3d`), `export` (headless screenshots), `all` (`plot`, `3d`, Polars, pandas, PyArrow).
See the [install page](https://gstvschlz.github.io/boitata/install/) for uv, Poetry, conda, pixi and offline installs.

## Examples

The [examples folder](https://github.com/gstvschlz/boitata/blob/main/examples) holds worked pages in 14 sections, each
alternating text, code and its results; the [docs render them with figures](https://gstvschlz.github.io/boitata/examples/01-first-steps/).
For the geostatistics itself, the [learn track](https://gstvschlz.github.io/boitata/learn/01-samples-and-support/learn_01/)
runs from what a sample stands for to checking a model.

## License

MIT

