some docs

This commit is contained in:
Jan Petykiewicz 2026-04-02 20:41:16 -07:00
commit 7ddfc0cd7f

23
README.md Normal file
View file

@ -0,0 +1,23 @@
# klamath-rs
A fast GDSII parser and writer in Rust, with Apache Arrow integration for efficient data handling.
## Overview
`klamath-rs` is designed to handle large GDSII files with high performance. It uses Apache Arrow as its primary in-memory data representation, allowing for efficient memory usage and easy integration with other tools in the Arrow ecosystem (like pandas, polars, or DuckDB via Python bindings).
## Documentation
- [Arrow Schema Documentation](ARROW_SCHEMA.md): Detailed information about the Arrow schema used for GDSII data.
## Features
- Fast parsing of GDSII files.
- Efficient memory representation using Apache Arrow.
- Support for common GDSII elements: SREF, AREF, Boundary, Path, Text, etc.
- Optimized "batch" representations for rectangles and boundaries sharing the same layer.
- C-compatible FFI for integration with other languages (e.g., Python).
## Usage
(To be added)