Skip to main content

An interpreter for the ARM instruction set and an accompanying Jupyter kernel

Project description

IArm is an ARM interpreter for the ARMv6 THUMB instruction set (More specifically for the ARM Cortex M0+ CPU). It supports almost 100% of the instructions, and some assembler directives. There is also its Jupyter kernel counterpart so it can be used with Jupyter notebooks. Check out the /docs folder to see a technical overview and some example notebooks.


Install with pip

pip install iarm

Or clone the repo and install with setuptools

python install

To install the Jupyer kernel counterpart, after installation, run

python -m iarm_kernel.install



Import the arm module and instantiate an interpreter from the Arm class

import iarm.arm
interp = iarm.arm.Arm()

To run code, pass the code into the evaluate method. Multiple lines can be sent in as well as one line at a time.

interp.evaluate(" MOVS R0, #5")
    MOVS R1, #3
    ADDS R2, R0, R1

By default, code is not run. The run method must be called.
print(interp.register)  # Print out the status of all the registers


Simply activate the iarm_kernel module and make a new notebook as an IArm notebook. Most of the magics have a 1 to 1 to the module. Refer to the notebooks in the /docs/examples folder and the %help magic.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (28.4 kB view hashes)

Uploaded source

Built Distribution

iarm-0.1.0-py3-none-any.whl (27.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page