mirror of
https://github.com/Cian-H/read_aconity_layers.git
synced 2025-12-22 18:31:56 +00:00
53 lines
1.3 KiB
ReStructuredText
53 lines
1.3 KiB
ReStructuredText
read_aconity_layers Documentation
|
|
==================================
|
|
|
|
A utility for fast reading of layer data from the aconity mini powder bed fusion machine.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
installation
|
|
quickstart
|
|
python/index
|
|
rust/index
|
|
development
|
|
|
|
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.
|
|
|
|
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
|
|
|
|
Quick Example
|
|
-------------
|
|
|
|
.. code-block:: 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/layer1.pcd", "/path/to/layer2.pcd"]
|
|
data = ral.read_selected_layers(files)
|
|
|
|
# Read a single layer
|
|
layer = ral.read_layer("/path/to/layer.pcd")
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|