anta-database 0.3.6__tar.gz → 0.4.0__tar.gz

{anta_database-0.3.6 → anta_database-0.4.0}/.gitignore

@@ -6,3 +6,8 @@ venv/
 .env
 dist/
 archives/
+
+.agent-shell/
+example*.py
+test*.py
+site/

anta_database-0.4.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: anta_database
+Version: 0.4.0
+Summary: SQLite database for the AntArchitecture Community Data
+Author: Antoine Hermant
+Author-email: antoine.hermant@etik.com
+License-Expression: MIT
+Project-URL: Homepage, https://antoinehermant.github.io/anta_database/intro
+Project-URL: Documentation, https://antoinehermant.github.io/anta_database/quick_start
+Project-URL: Repository, https://github.com/antoinehermant/anta_database.git
+Project-URL: Issues, https://github.com/antoinehermant/anta_database/issues
+Keywords: isochrones,database,IRH,radar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Programming Language :: Python
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: geopandas
+Requires-Dist: fastparquet
+Requires-Dist: pyarrow
+Requires-Dist: xarray
+Requires-Dist: h5netcdf
+Requires-Dist: h5py
+Requires-Dist: pyproj
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: colormaps
+Requires-Dist: tqdm
+Requires-Dist: pyshp
+Dynamic: license-file
+
+<h1 align="center">
+<a href="https://antoinehermant.github.io/anta_database/index">
+<img src="https://raw.githubusercontent.com/antoinehermant/anta_database/main/book/logo.png" width="200">
+</a>
+</h1>
+
+[![PyPI version](https://img.shields.io/pypi/v/anta_database)](https://pypi.org/project/anta_database/)
+[![Downloads](https://img.shields.io/pypi/dm/anta_database)](https://pypi.org/project/anta_database/)
+[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/antoinehermant/anta_database/issues)
+
+# AntADatabase
+
+**Visit the [Home Page](https://antoinehermant.github.io/anta_database/index) for full documentation and examples.**
+
+**SQL database for the AntArchitecture Community Data**
+
+AntADatabase is a Python package providing efficient access to Internal Reflecting Horizons (isochrones) data across Antarctica. Designed for ice sheet modelers, it offers fast, memory-efficient data structures to constrain models with published IRH data.
+
+## Key Features
+
+- **SQL Indexing**: Fast querying of IRH data by dataset, institute, project, age, region, basin, variable, or flight ID
+- **HDF5 Storage**: Data stored in HDF5 format for optimal read performance
+- **Plotting Tools**: Built-in visualization functions for quick data exploration
+- **Lazy Data Generation**: Generate data for later use
+
+## Data Variables
+
+Each dataset contains (when available):
+- `PSX`, `PSY`: Coordinates
+- `Distance`: Along-track distance
+- `IRH_DEPTH`: Internal Reflecting Horizon depth
+- `IRH_NUM`: Number of traced IRHs per point
+- `ICE_THK`: Ice thickness
+- `SURF_ELEV`: Surface elevation
+- `BED_ELEV`: Bed elevation
+
+## Installation
+
+```bash
+pip install anta_database
+```
+
+For the latest development version:
+```bash
+pip install git+https://github.com/antoinehermant/anta_database.git
+```
+
+## Quick Start
+
+```python
+from anta_database import Database
+
+# Initialize database (contact maintainer for data access)
+db = Database("/path/to/AntADatabase/")
+
+# Query data by various criteria
+db.query(dataset="Cavitte_2020", age=10000)
+
+# Visualize data
+db.plot.var(title="My IRH Data")
+```
+
+## Documentation
+
+Full documentation and examples are available on the [Home Page](https://antoinehermant.github.io/anta_database/index).
+
+## Data Access
+
+The database files are not publicly hosted. Please contact [antoine.hermant@unibe.ch](mailto:antoine.hermant@unibe.ch) to request access to the data.
+
+## Support
+
+- **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/antoinehermant/anta_database/issues)
+- **Contact**: antoine.hermant@unibe.ch
+
+## Citation
+
+If you use this tool in your work, please cite this repository and the original data sources using their provided DOIs.
+
+## Acknowledgments
+
+Developed as part of the CHARIBDIS project (Swiss National Science Foundation grant no. 211542).
+

anta_database-0.4.0/README.md

@@ -0,0 +1,83 @@
+<h1 align="center">
+<a href="https://antoinehermant.github.io/anta_database/index">
+<img src="https://raw.githubusercontent.com/antoinehermant/anta_database/main/book/logo.png" width="200">
+</a>
+</h1>
+
+[![PyPI version](https://img.shields.io/pypi/v/anta_database)](https://pypi.org/project/anta_database/)
+[![Downloads](https://img.shields.io/pypi/dm/anta_database)](https://pypi.org/project/anta_database/)
+[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/antoinehermant/anta_database/issues)
+
+# AntADatabase
+
+**Visit the [Home Page](https://antoinehermant.github.io/anta_database/index) for full documentation and examples.**
+
+**SQL database for the AntArchitecture Community Data**
+
+AntADatabase is a Python package providing efficient access to Internal Reflecting Horizons (isochrones) data across Antarctica. Designed for ice sheet modelers, it offers fast, memory-efficient data structures to constrain models with published IRH data.
+
+## Key Features
+
+- **SQL Indexing**: Fast querying of IRH data by dataset, institute, project, age, region, basin, variable, or flight ID
+- **HDF5 Storage**: Data stored in HDF5 format for optimal read performance
+- **Plotting Tools**: Built-in visualization functions for quick data exploration
+- **Lazy Data Generation**: Generate data for later use
+
+## Data Variables
+
+Each dataset contains (when available):
+- `PSX`, `PSY`: Coordinates
+- `Distance`: Along-track distance
+- `IRH_DEPTH`: Internal Reflecting Horizon depth
+- `IRH_NUM`: Number of traced IRHs per point
+- `ICE_THK`: Ice thickness
+- `SURF_ELEV`: Surface elevation
+- `BED_ELEV`: Bed elevation
+
+## Installation
+
+```bash
+pip install anta_database
+```
+
+For the latest development version:
+```bash
+pip install git+https://github.com/antoinehermant/anta_database.git
+```
+
+## Quick Start
+
+```python
+from anta_database import Database
+
+# Initialize database (contact maintainer for data access)
+db = Database("/path/to/AntADatabase/")
+
+# Query data by various criteria
+db.query(dataset="Cavitte_2020", age=10000)
+
+# Visualize data
+db.plot.var(title="My IRH Data")
+```
+
+## Documentation
+
+Full documentation and examples are available on the [Home Page](https://antoinehermant.github.io/anta_database/index).
+
+## Data Access
+
+The database files are not publicly hosted. Please contact [antoine.hermant@unibe.ch](mailto:antoine.hermant@unibe.ch) to request access to the data.
+
+## Support
+
+- **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/antoinehermant/anta_database/issues)
+- **Contact**: antoine.hermant@unibe.ch
+
+## Citation
+
+If you use this tool in your work, please cite this repository and the original data sources using their provided DOIs.
+
+## Acknowledgments
+
+Developed as part of the CHARIBDIS project (Swiss National Science Foundation grant no. 211542).
+

anta_database-0.4.0/ROADMAP.md

@@ -0,0 +1,18 @@
+# Roadmap
+
+Here is a todo list of features that we want to include in the AntADatabase.
+
+## Important
+- [x] Implement HDF5 format (In process, for next release)
+- [x] Filter by radar system
+- [x] Create shapefiles, e.g. for QAntarctica
+- [ ] More familiar basin/region naming (e.g. Wilkes, Thwaites etc)
+- [ ] Cloud host (some testing with cloud_database branch)
+- [ ] Improved age assignment (currently hardcoded during raw data processing, but could be done in the Indexing so ages are updated simply by reindexing)
+- [ ] Sort airbone vs ground-based data (e.g. extra flag)
+
+## To discuss
+- [ ] A netCDF version 
+- [ ] Implement method to date layers from closest/latest chronology
+- [ ] Refine isochrone ages for consistent layers across the database
+

anta_database-0.4.0/anta_database/__init__.py

@@ -0,0 +1,30 @@
+"""
+Anta Database Package
+
+Main package for isochrone database access and processing.
+"""
+
+# Database modules
+from .database.database import Database
+
+# Compiling modules
+from .compiling.zarr_converter_simple import FlightLineZarrConverter
+from .compiling.compile import CompileDatabase
+
+# Indexing modules
+from .indexing.index_database import IndexDatabase
+
+# Plotting modules
+from .plotting.plotting import Plotting
+
+__all__ = [
+    # Database classes
+    "Database",
+    # Compiling classes
+    "FlightLineZarrConverter",
+    "CompileDatabase",
+    # Indexing functions
+    "IndexDatabase",
+    # Plotting functions
+    "Plotting",
+]

anta_database-0.4.0/anta_database/compiling/__init__.py

@@ -0,0 +1,10 @@
+"""
+Compiling module
+
+Contains classes and functions for data compilation and conversion.
+"""
+
+from .zarr_converter_simple import FlightLineZarrConverter
+from .compile import CompileDatabase
+
+__all__ = ["FlightLineZarrConverter", "CompileDatabase"]