Formatted docs with rstfmt

This commit is contained in:
2025-05-28 17:23:04 +01:00
parent c2902166dc
commit 38ae2fa1c7
8 changed files with 360 additions and 312 deletions

View File

@@ -1,31 +1,37 @@
Overview
--------
##########
Overview
##########
``read_aconity_layers`` is a high-performance Python library for reading and processing layer data from Aconity mini powder bed fusion machines. It's built with Rust for maximum performance and uses PyO3 for seamless Python integration.
``read_aconity_layers`` is a high-performance Python library for reading
and processing layer data from Aconity mini powder bed fusion machines.
It's built with Rust for maximum performance and uses PyO3 for seamless
Python integration.
Features
--------
##########
Features
##########
* **Fast**: Built with Rust for high-performance data processing
* **Simple**: Easy-to-use Python API
* **Parallel**: Leverages Rayon for parallel processing of multiple files
* **Type-safe**: Full type annotations and stub files included
- **Fast**: Built with Rust for high-performance data processing
- **Simple**: Easy-to-use Python API
- **Parallel**: Leverages Rayon for parallel processing of multiple
files
- **Type-safe**: Full type annotations and stub files included
Quick Example
-------------
###############
Quick Example
###############
.. code-block:: python
.. code:: python
import read_aconity_layers as ral
import numpy as np
# Read all layers from a directory
data = ral.read_layers("/path/to/layer/files/")
# Read specific layer files
files = ["/path/to/0.01.pcd", "/path/to/0.02.pcd"]
data = ral.read_selected_layers(files)
# Read a single layer
layer = ral.read_layer("/path/to/0.01.pcd")