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

35
README.rst
View File

@@ -1,5 +1,6 @@
#####################
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
@@ -29,27 +30,34 @@ read_aconity_layers
.. 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 - **Fast**: Built with Rust for high-performance data processing
* **Simple**: Easy-to-use Python API - **Simple**: Easy-to-use Python API
* **Parallel**: Leverages Rayon for parallel processing of multiple files - **Parallel**: Leverages Rayon for parallel processing of multiple
* **Type-safe**: Full type annotations and stub files included 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 read_aconity_layers as ral
import numpy as np import numpy as np
@@ -63,4 +71,3 @@ Quick Example
# 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")