IForth

Forth kernel for Jupyter notebook / lab. This is a fork of github.com/jdfreder/iforth.

Open in Colab

Note: Check the changelog to see the latest changes in development as well as in releases.

Installation

• Check python --version to ensure you're running Python 3 only (Python 2 is NOT supported).
• Install Gforth. Make sure it is accessible via the commandline/terminal (gforth --version).
• Run pip install forth_kernel

Note: On Windows, gforth doesn't work. Instead, run using docker

Development Installation

Clone this repository and do an editable pip install in this repository's folder:

pip install -e .
jupyter kernelspec install ./forth --user   

Installing with Docker

• Clone this repo and cd to project root.
• Build the docker image: docker build -t iforth-testing . --build-arg version=testing
• Run it: docker run --rm -it -v ${PWD}:/home/jovyan/project -p 8888:8888 iforth-testing This mounts your current working directory as /home/jovyan/project in the docker container.

Usage

• Run jupyter notebook (or jupyter lab, whichever you prefer).
• In a new or existing notebook, use the kernel selector (located at the top right of the notebook) to select IForth.

Files Description

• *forth_kernel/ - Python source code
  • forth_kernel.py - main code
  • init.py, main.py - for marking as python package
  • py.typed - for enabling type hint support when importing as Python library forth_kernel.
• forth/kernel.json - specification for IForth jupyter kernel (to be installed with jupyter kernelspec install).

TODO

• Unit Tests
• Github CI / CD

BUGS

• In Dockerfile, versions stable and development are not working. Only testing version works.