From 3642caf011c0afabb21f4c32767e07c33295e7bb Mon Sep 17 00:00:00 2001 From: pvanheus Date: Sat, 6 Oct 2018 19:43:50 +0200 Subject: [PATCH] Add instructions for running using Singularity `gem` install requires a working Ruby environment. As an alternative, a Singularity containers can be build and used to run CrystalSCAD. This PR adds instructions for that. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 3ee307d..31364a0 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,18 @@ The SCAD files output from CrystalSCAD are found in `source_files/stethoscope_he * PrintableStethoscopeHead1Assembly_output.scad - The head * EarplugMold_output.scad - Earplug mold +As an alternative to installing via ``gem`` you can run CrystalSCAD using a [Singularity](https://www.sylabs.io/) +container image. Build the image and run it using: + +``` +cd source_files/stethoscope_head +singularity build crystalscad.img docker://rubygem/crystalscad:latest +mkdir output +singularity exec crystalscad.simg ruby stethoscope_head.rb +``` + +As above, output SCAD files are in the `output/` directory. + Mass Manufacturing ================== We generally print 3 stethoscopes per plate to ensure that each stethoscope is created out of the same material.