https://github.com/pschatzmann/jupyter-openscad-kernel

Jupyter kernel for OpenSCAD
https://github.com/pschatzmann/jupyter-openscad-kernel

Last synced: 2 months ago
JSON representation

Jupyter kernel for OpenSCAD

• Host: GitHub
• URL: https://github.com/pschatzmann/jupyter-openscad-kernel
• Owner: pschatzmann
• Created: 2020-02-26T09:42:36.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-03-13T08:34:31.000Z (almost 3 years ago)
• Last Synced: 2024-10-11T13:36:33.807Z (3 months ago)
• Language: Python
• Size: 402 KB
• Stars: 11
• Watchers: 4
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# OpenSCAD Kernel for Jupyter

I was missing a Jupyter Kernel for [OpenSCAD](https://www.openscad.org/). So I took up the challenge and here is the result.  

Any regular text in a cell is added to the overall OpenSCAD code buffer. This allows you to build up an OpenSCAD model in multiple steps using Jupyter cells and document the design along the way.

## Preconditions

- Jupyter or Jupyterlab should have been installed

- Please make sure that OpenSCAD has been installed on your system (e.g. with apt install openscad) and that it can be called on the command line:

```

openscad -v

```

diplays the version. E.g. 2019.12.20

## Installation

```

pip install jupyter-openscad-kernel

python -m iopenscad.install

```

## Installation from source

```

git clone https://github.com/pschatzmann/jupyter-openscad-kernel.git

cd jupyter-openscad-kernel

pip install .

python -m iopenscad.install

```

## Optional Steps

If you want to be able to display stl files you need to install a mime renderer for Jupyter. E.g

```

jupyter labextension install jupyterlab-viewer-3d

```

If you want to have syntax highlighting for OpenSCAD:

```

jupyter labextension install jupyterlab-openscad-syntax-highlighting

```

On linux, if you want to run openscad in a headless environment (e.g. Docker) you need to install xvfb

```

apt install -y xvfb

```

Now you can launch your kernel my calling

```

jupyter lab

```

or 

```

jupyter workspace

```

## Versions

- 1.0     Initial Version

- 1.0.1   Additional syntax checking; Publish to pypi

- 1.0.13  Error corrections for parser and installer, support for %use

- 1.0.14  Cleanup and corrections for spelling mistakes, Upgrade node and setuptools release in Dockerfile 

## Further Information

- A quick [Overview](https://www.pschatzmann.ch/home/2020/02/26/an-openscad-kernel-in-jupyter/)