Cian-H/read_aconity_layers
1
0
Fork 0
mirror of https://github.com/Cian-H/read_aconity_layers.git synced 2025-12-23 02:31:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rebuilt README.rst

Browse Source
This commit is contained in:
Cian Hughes
2025-05-29 09:44:27 +01:00
parent 6ebc2ebc33
commit ce3e0f623c
1 changed files with 36 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
README.rst
View File

@@ -1,66 +1,73 @@
read_aconity_layers #####################
================================== read_aconity_layers
#####################
.. image:: https://github.com/Cian-H/read_aconity_layers/workflows/CI/badge.svg .. image:: https://github.com/Cian-H/read_aconity_layers/workflows/CI/badge.svg
:target: https://github.com/Cian-H/read_aconity_layers/actions/workflows/CI.yml :target: https://github.com/Cian-H/read_aconity_layers/actions/workflows/CI.yml
.. image:: https://github.com/Cian-H/read_aconity_layers/workflows/Python/badge.svg .. image:: https://github.com/Cian-H/read_aconity_layers/workflows/Python/badge.svg
:target: https://github.com/Cian-H/read_aconity_layers/actions/workflows/Python.yml :target: https://github.com/Cian-H/read_aconity_layers/actions/workflows/Python.yml
.. image:: https://github.com/Cian-H/read_aconity_layers/workflows/Rust/badge.svg .. image:: https://github.com/Cian-H/read_aconity_layers/workflows/Rust/badge.svg
:target: https://github.com/Cian-H/read_aconity_layers/actions/workflows/Rust.yml :target: https://github.com/Cian-H/read_aconity_layers/actions/workflows/Rust.yml
.. image:: https://img.shields.io/pypi/dm/read-aconity-layers.svg .. image:: https://img.shields.io/pypi/dm/read-aconity-layers.svg
:target: https://pypi.python.org/pypi/read-aconity-layers :target: https://pypi.python.org/pypi/read-aconity-layers
.. image:: https://img.shields.io/github/tag/Cian-H/read_aconity_layers.svg .. image:: https://img.shields.io/github/tag/Cian-H/read_aconity_layers.svg
:target: https://github.com/Cian-H/read_aconity_layers/releases :target: https://github.com/Cian-H/read_aconity_layers/releases
.. image:: https://img.shields.io/github/license/Cian-H/read_aconity_layers.svg .. image:: https://img.shields.io/github/license/Cian-H/read_aconity_layers.svg
:target: https://github.com/Cian-H/read_aconity_layers/blob/main/LICENSE :target: https://github.com/Cian-H/read_aconity_layers/blob/main/LICENSE
.. image:: https://readthedocs.org/projects/read-aconity-layers/badge/?version=latest .. image:: https://readthedocs.org/projects/read-aconity-layers/badge/?version=latest
:target: https://read-aconity-layers.readthedocs.io/en/latest/?badge=latest :target: https://read-aconity-layers.readthedocs.io/en/latest/?badge=latest
.. image:: https://coveralls.io/repos/github/Cian-H/read_aconity_layers/badge.svg?branch=main .. image:: https://coveralls.io/repos/github/Cian-H/read_aconity_layers/badge.svg?branch=main
:target: https://coveralls.io/github/Cian-H/read_aconity_layers?branch=main :target: https://coveralls.io/github/Cian-H/read_aconity_layers?branch=main
.. image:: https://img.shields.io/badge/code%20style-Ruff-D7FF64.svg .. image:: https://img.shields.io/badge/code%20style-Ruff-D7FF64.svg
:target: https://github.com/astral-sh/ruff :target: https://github.com/astral-sh/ruff
================================== ----
A library for fast reading of layer data from the aconity mini powder bed fusion machine. A library for fast reading of layer data from the aconity mini powder
bed fusion machine.
##########
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 Quick Example
* **Parallel**: Leverages Rayon for parallel processing of multiple files ###############
* **Type-safe**: Full type annotations and stub files included
Quick Example .. code:: python
-------------
.. code-block:: python
import read_aconity_layers as ral import read_aconity_layers as ral
import numpy as np import numpy as np
# Read all layers from a directory # Read all layers from a directory
data = ral.read_layers("/path/to/layer/files/") data = ral.read_layers("/path/to/layer/files/")
# Read specific layer files # Read specific layer files
files = ["/path/to/0.01.pcd", "/path/to/0.02.pcd"] files = ["/path/to/0.01.pcd", "/path/to/0.02.pcd"]
data = ral.read_selected_layers(files) data = ral.read_selected_layers(files)
# Read a single layer # Read a single layer
layer = ral.read_layer("/path/to/0.01.pcd") layer = ral.read_layer("/path/to/0.01.pcd")