Metadata-Version: 2.4
Name: baselode
Version: 0.1.12
Summary: Domain-aware data models and utilities for exploration and mining datasets.
Author: Tamara Vasey
Maintainer: Darkmine Pty Ltd
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/darkmine-oss/baselode
Project-URL: Repository, https://github.com/darkmine-oss/baselode
Project-URL: Issues, https://github.com/darkmine-oss/baselode/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=1.5
Requires-Dist: numpy>=1.23
Requires-Dist: plotly>=5.0
Requires-Dist: geopandas>=0.13
Requires-Dist: pyproj>=3.4
Requires-Dist: pyarrow>=12.0
Provides-Extra: viz
Requires-Dist: folium>=0.15; extra == "viz"
Provides-Extra: sql
Requires-Dist: sqlalchemy>=2.0; extra == "sql"
Provides-Extra: all
Requires-Dist: folium>=0.15; extra == "all"
Requires-Dist: sqlalchemy>=2.0; extra == "all"
Dynamic: license-file

# BASELODE (Python)

Baselode is an open-source Python toolkit for working with structured exploration and mining datasets.

Version 0.1.0 focuses on domain-aware data models and validation utilities for drillhole-style data. The goal is to provide a consistent foundation for analytics, visualization, and AI workflows.

---

## Installation

```bash
pip install baselode
```

**Requires:** Python 3.12+

---

## Example

```python
import baselode.drill.data

gdf = baselode.drill.data.load_collars(COLLAR_CSV)
```

---

## Included in 0.1.0

- Drillhole collar, survey, and assay models  
- Downhole interval structures  
- Basic validation utilities  
- Strip log visualisations
- Map visualisations
- 3D visualisations (requires the `baselode` javascript module from npm)

---

## Design Principles

- Explicit domain models (not generic tables)  
- Minimal dependencies  
- Visualisation tooling as key to data analysis
- Designed for integration with analytics, GIS, and AI systems  

---

## Roadmap

Future releases may include:

- Assay and lithology schemas  
- Geospatial helpers  
- Interoperability with common mining formats  
- Visualization adapters  

---

## License

GNU General Public License v3.0 or later (GPL-3.0-or-later).

See the `LICENSE` file in this repository for full details.

---

## Contributing

Contributions and issue reports are welcome via GitHub.
