Merge pull request #1 from cda-tum/clone-openslaice-from-orig-repo

copied code from original repo

Author: MariaEmmerich

.gitignore

@@ -0,0 +1,3 @@
+**/__pycache__/
+**/export/
+**/build/

ATTRIBUTION.md

@@ -0,0 +1,19 @@
+# Attribution for Included STL Files
+
+The following STL files are included in this repository under the Creative Commons Attribution 4.0 International License (CC BY 4.0):
+
+1. **mixer.stl**
+   - **Author**: Mohamed Yafia & Oriol Ymbern
+   - **Source**: [[Printables](https://www.printables.com/model/863725-embedded-microfluidic-mixer)]
+   - **License**: Creative Commons Attribution 4.0 International (CC BY 4.0)
+
+2. **ELISA_chip.stl**
+   - **Author**: Mohamed Yafia & Oriol Ymbern
+   - **Source**: [[Printables](https://www.printables.com/model/863723-microfluidic-elisa-chip)]
+   - **License**: Creative Commons Attribution 4.0 International (CC BY 4.0)
+
+For more details on the license, see [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/).
+
+---
+
+All other files in this repository are licensed under the MIT License unless otherwise noted.

OpenSLAice.ipynb

@@ -0,0 +1,140 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "ac3a86a4",
+   "metadata": {},
+   "source": [
+    "### Needed imports"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "afc55f24",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import sys\n",
+    "import os\n",
+    "import numpy as np\n",
+    "\n",
+    "# Add the project root directory to Python path\n",
+    "project_root = os.path.dirname(os.path.abspath(os.getcwd()))\n",
+    "if project_root not in sys.path:\n",
+    "    sys.path.append(project_root)\n",
+    "\n",
+    "import src.slicer.resins\n",
+    "import src.slicer.printers\n",
+    "from src.slicer.core.printer import PrinterRegistry\n",
+    "from src.slicer.core.resin import ResinRegistry\n",
+    "from src.slicer.core.slicer import Slicer, ParameterMode\n",
+    "from src.slicer.calibration.calibration import create_calibration_print\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "aa633e0b",
+   "metadata": {},
+   "source": [
+    "### Test Calibration print\n",
+    "\n",
+    "change the exposuretimes to the values you want to test for the 8 test samples"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5e59aa94",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "printer = PrinterRegistry.get(\"Anycubic Mono4 Ultra\")\n",
+    "resin = ResinRegistry.get(\"Resin for Calibration\")\n",
+    "export_path = \"/home/benni/Documents/Repos/MF-SLA-Slicer/src/slicer/export/\"\n",
+    "exp_test_start = 4.0\n",
+    "exp_test_steps = 0.6\n",
+    "exp_to_test = []\n",
+    "for i in range(8):\n",
+    "    exp_to_test.append(round(exp_test_start + i * exp_test_steps, 2))\n",
+    "exp_to_test = exp_to_test[::-1]  # Reverse the list to start with the lowest exposure time\n",
+    "print(exp_to_test)\n",
+    "\n",
+    "create_calibration_print(\n",
+    "    printer=printer,\n",
+    "    resin=resin,\n",
+    "    export_path=export_path,\n",
+    "    layer_height=0.05,\n",
+    "    exp_time_base=4.5,\n",
+    "    exp_times_to_test=exp_to_test,\n",
+    "    exp_time_first_layers=40.0,\n",
+    "    first_layers=5\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "a0292d48",
+   "metadata": {},
+   "source": [
+    "### Test Slice\n",
+    "1. choose one of the example stls and use the path variable in the function `add_input_file`\n",
+    "2. change the file name and the path where the file is stored in the function `save` acording to your needs\n",
+    "3. run the code"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "66a0e921",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "spheroid = \"./examples/stls/spheroid_vsmall.stl\"\n",
+    "mixer = \"./examples/stls/mixer.stl\"\n",
+    "elisa = \"./examples/stls/ELISA_chip.stl\"\n",
+    "rot_spheroid = \"./examples/stls/spheroid_vsmall_rotated.stl\"\n",
+    "rot_mixer = \"./examples/stls/mixer_rotated.stl\"\n",
+    "rot_elisa = \"./examples/stls/elisa_rotated.stl\"\n",
+    "docking_plate_subsection = \"/home/benni/Downloads/docking_plate_subsection.stl\"\n",
+    "\n",
+    "printer = PrinterRegistry.get(\"Anycubic Mono4 Ultra\")\n",
+    "resin = ResinRegistry.get(\"Anycubic Standard Clear\")\n",
+    "\n",
+    "mf_sla_slicer = Slicer(printer=printer, resin=resin)\n",
+    "mf_sla_slicer.add_input_file(spheroid)\n",
+    "mf_sla_slicer.auto_orientation()\n",
+    "\n",
+    "\n",
+    "mf_sla_slicer.auto_arrange(2)\n",
+    "#mf_sla_slicer.stls[0].set_position_mm(0.5, 12.0)\n",
+    "mf_sla_slicer.set_layer_height_method(ParameterMode.AUTO)\n",
+    "mf_sla_slicer.set_forced_layer_height(0.02)\n",
+    "mf_sla_slicer.slice_all()\n",
+    "mf_sla_slicer.rasterize(255)\n",
+    "mf_sla_slicer.save(\"spheroid\", \"/home/benni/Downloads\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

README.md

@@ -0,0 +1,88 @@
+<div align="center">
+
+# OpenSLAice
+
+**A specialized slicer for microfluidic SLA/mSLA 3D printing**
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+
+</div>
+
+## Overview
+
+OpenSLAice is a specialized slicer for microfluidic SLA/mSLA 3D printing, developed as part of a bachelor thesis project. It addresses the unique challenges of printing microfluidic devices with high precision and reliability.
+
+### Key Innovations
+
+1. **Physical Model-Based Calibration**: Single-print calibration method that predicts exposure times for arbitrary layer heights based on a physical model of light penetration.
+
+2. **Automated Microfluidic Feature Detection**: Automatically detects and orients microfluidic features to minimize stair-stepping artifacts, resulting in smoother channel walls.
+
+3. **Dynamic Layer Height Selection**: Intelligently balances print quality with speed by varying layer heights throughout the print - using fine layers for precise channels and thicker layers for stable channel top layers.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.9+
+- Jupyter Notebook
+
+### Installation dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+### Usage
+
+#### Main Application
+
+Open the main Jupyter notebook `OpenSLAice.ipynb` to access a simple example for how to use OpenSLAice.
+
+#### Exposure Calibration
+
+A specialized notebook is available for calibrating exposure `exp_calibration.ipynb`.
+
+This notebook determine the needed resin model parameter used in the physical model for exposure time prediction. With these parameters and some metadata you can add any resin to the OpenSLAice database and use it for printing.
+
+## Irradiance Measurements
+
+The currently used resin parameters are where calibrated using the Anycubic Mono 4 Ultra with a measured irradiance of 1938.24 μW/cm² at 400nm at the FEP film. 
+To ensure accurate exposure times across different printers, an irradiance sensor is provided to reuse the physical model.
+
+In the `irradiance_sensor` directory, you'll find resources for building and using an irradiance sensor:
+
+- **KiCad PCB Design**: Complete PCB design files for building a sensor board
+- **Arduino Code**: Firmware for an ESP32-S3 SuperMinni with OPT3002 irradiance sensor
+- **Usage Instructions**: How to measure and calibrate UV irradiance for your printer
+
+This sensor allows precise measurement of your printer's light source intensity, enabling reuse of the physical model for exposure time prediction across different printers without needing to recalibrate.
+
+## Project Structure
+
+```
+OpenSLAice/
+├── examples/                # Example STL files and projects
+│   ├── stls/                # Directory for STL files
+│   │   ├── mixer.stl        # Example mixer STL
+│   │   └── ELISA_chip.stl   # Example ELISA chip STL
+│   └── ...                  # Other example projects
+├── irradiance_sensor/       # Resources for irradiance sensor
+│   ├── firmware/            # ESP32-S3 firmware for sensor
+│   ├── kicad_pcb/           # KiCad PCB design files
+│   └── README.md            # Sensor usage instructions
+├── OpenSLAice.ipynb         # Main Jupyter notebook for OpenSLAice
+├── exp_calibration.ipynb    # Jupyter notebook for exposure calibration
+├── requirements.txt          # Python package dependencies
+└── README.md                # Project overview and documentation
+```
+
+## Licensing
+
+This repository is licensed under the MIT License. However, the following STL files are included under the Creative Commons Attribution 4.0 International License (CC BY 4.0):
+
+- `examples/stls/mixer.stl`
+- `examples/stls/ELISA_chip.stl`
+
+See the [ATTRIBUTION.md](ATTRIBUTION.md) file for details.