Welcome 👋

Overview

Artemis is a powerful, non-invasive way to create an interactive interface for your production code.

Our users leave simple comments called “anchors” in their codebase that automatically generate interactive inputs, outputs and documentation when run with Artemis.

To run a program with Artemis, simply use our command-line utility artemis_labs. Artemis will launch an offline browser window that displays the user’s code alongside its corresponding interface.

Here’s what an Artemis interface looks like:

19201920

The interface, generated from anchors, is on the left. The code on the right contains the anchors, which are comments beginning with "@."

Types of Anchors

Anchors can be used to create three types of interface elements:

  1. Inputs
    Enable you to alter variables in your code via the interface

  2. Outputs
    Represent the products of your code (graphs, text, numbers, images, etc.)

  3. Documentation
    Appear in your interface as your code runs, great for construction walkthroughs (images, GIFs, videos, links, text)

There are two main ways Artemis users leverage these types of Anchors, to make their code easier to run and to explain how it works.

Make your scripts more functional with Artemis

Many engineers use Artemis to make their computational scripts more convenient. Instead of typing new variables into a Python program directly, our users simply leave input anchors for variables they’ll need to change and run so they can make calculations faster via an easy-to-use interface.

Document with Artemis

Artemis is also commonly used as a documentation tool. Users place anchors containing text, code snippets, images, GIFs, videos or links that explain what’s going on in their program that display in the interface at relevant times. What appears in the Artemis browser window can also be exported and shared as a small HTML file. Engineers at Mayo Clinic presently use Artemis to share code, quickly validating their work and onboarding their colleagues to new programs.

How Exactly Do Anchors Work?

Creating an anchor is easy.

All anchors begin with “@” and are followed by their type, “input,” “output” or “doc.”

For doc anchors, just continue to enter whatever information you need in markdown format.

For inputs and outputs specify which type of data you want input (text, number) or what type of data you’d like output (graph, number, table, etc.).

Finally, specify which variable you’d like the input to act upon or output to represent by typing “data= x,” with x being your variable.


What’s Next
Did this page help you?