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

Formatted docs with rstfmt

Browse Source
This commit is contained in:
Cian Hughes
2025-05-28 17:23:04 +01:00
parent c2902166dc
commit 38ae2fa1c7
8 changed files with 360 additions and 312 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/python/index.rst
View File

@@ -1,25 +1,30 @@
Python API Reference
====================
######################
Python API Reference
######################
This section contains the complete Python API reference for ``read_aconity_layers``.
This section contains the complete Python API reference for
``read_aconity_layers``.
Module
-----------
********
Module
********
.. automodule:: read_aconity_layers
:members:
:undoc-members:
:show-inheritance:
Return Type Information
-----------------------
*************************
Return Type Information
*************************
The library includes comprehensive type stubs for full IDE support and type checking.
The library includes comprehensive type stubs for full IDE support and
type checking.
All functions return NumPy arrays with the following structure:
* **Column 0**: X coordinates (corrected)
* **Column 1**: Y coordinates (corrected)
* **Column 2**: Z coordinates (layer height)
* **Column 3**: Pyrometer 1 readings
* **Column 4**: Pyrometer 2 readings
- **Column 0**: X coordinates (corrected)
- **Column 1**: Y coordinates (corrected)
- **Column 2**: Z coordinates (layer height)
- **Column 3**: Pyrometer 1 readings
- **Column 4**: Pyrometer 2 readings