TileDB Python library for supporting Climate and Forecast datasets.
Project description
TileDB-CF-Py
The TileDB-CF-Py library is a Python library for supporting the NetCDF data model in the TileDB storage engine. TileDB-CF-Py provides readers and writers for viewing and manipulating TileDB arrays and groups using TileDB CF Dataspaces - a special TileDB group that follows the requirements in tiledb-cf-spec.md.
TileDB Quick Links
Getting Started
Quick Installation
This project is available from PyPI and may be installed with pip
:
pip install tiledb-cf
Documentation
API Documentation
To build the API documentation do the following from this projects root directory:
- Install required packages:
python3 -m pip install tiledb-cf[docs]
- Make the HTML document:
make -C docs/ html
- Open docs/_build/html/index.html in a web browser of your choice.
Example Notebooks
Example Jupyter notebooks are available in the examples folder.
Command Line Interface
TileDB-CF provides a command line interface. Currently, it has the following commands:
Usage: tiledb-cf netcdf-convert [OPTIONS]
Converts a NetCDF input file to nested TileDB groups.
Options:
-i, --input-file TEXT The path or URI to the NetCDF file that will be converted. [required]
-o, --output-uri TEXT The URI for the output TileDB group. [required]
--input-group-path TEXT The path in the input NetCDF for the root group that will be converted. [default: /]
--recursive / --no-recursive Recursively convert all groups contained in the input group path. [default: True]
-k, --output-key TEXT Key for the generated TileDB arrays.
--unlimited-dim-size INTEGER Size to convert unlimited dimensions to. [default: 10000]
--dim-dtype [int8|int16|int32|int64|uint8|uint16|uint32|uint64]
The data type for TileDB dimensions created from converted NetCDF. [default: uint64]
--help Show this message and exit.
Development
For information on contributing to this project see the CONTRIBUTING document.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tiledb_cf-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 539d0c74d8f17649e62039f9f259f407a362b1b278ffd6aaea37756ab8c65ec8 |
|
MD5 | d37e8ff569fe2d7f52e196ac973b4e62 |
|
BLAKE2b-256 | 2705f311ff0e25cacf485c5fa9ae444c3fca8fc7886008273a152539ffef59b2 |