A reactive notebook for Python: run reproducible experiments, bring data to life with UI elements, execute as a script, deploy as an app, and version with git.

marimo-team marimo-team Last update: Jan 03, 2024

A reactive Python notebook that's reproducible, git-friendly, and deployable as scripts or apps.

Docs · Discord · Examples

marimo is a reactive notebook for Python. It allows you to rapidly experiment with data and models, code with confidence in your notebook's correctness, and productionize notebooks as pipelines or interactive web apps.

Highlights.

  • reactive: run a cell, and marimo automatically updates all affected cells and outputs
  • interactive: bind sliders, tables, plots, and more to Python — no callbacks required
  • reproducible: no hidden state, deterministic execution order
  • git-friendly: stored as .py files
  • deployable: executable as a script, deployable as an app
pip install marimo && marimo tutorial intro

marimo

Watch the animated GIF as a video at this link.

Quickstart

Installation. In a terminal, run

pip install marimo
marimo tutorial intro

You should see a tutorial notebook in your browser.

marimo is also available through Conda: conda install -c conda-forge marimo.

Create notebooks. Create an empty notebook with

marimo edit

or create/edit a notebook with a given name with

marimo edit your_notebook.py
  • marimo reacts to your code changes, like a spreadsheet! This rapid feedback ensures your code and outputs are always in sync.

  • Import marimo in your notebooks to use interactive elements, like sliders, dropdowns, tables, and more.

See our docs to learn more, including how to layout outputs in tabs, rows, columns, and more.

Run apps. Run your notebook as a web app, with Python code hidden and uneditable:

marimo run your_notebook.py

This app is deployed on marimo cloud, our platform for deploying marimo notebooks and supercharging them with cloud resources.

Execute as scripts. marimo noteboooks can be executed as scripts at the command line:

python your_notebook.py

Automatically convert Jupyter notebooks. Automatically convert Jupyter notebooks to marimo notebooks with the CLI

marimo convert your_notebook.ipynb > your_notebook.py

or use our web interface.

Tutorials. List all tutorials:

marimo tutorial --help

GitHub Copilot. The marimo editor natively supports GitHub Copilot. Enable it via the settings menu in the marimo editor.

VS Code extension. If you prefer VS Code over terminal, try our VS Code extension.

Learn more

marimo is easy to get started with, with lots of room for power users. In addition to experimenting with code and models in a reproducible environment, marimo lets you build powerful tools including data labelers, embedding visualizers, and model evaluation dashboards, with surprisingly little code.

Examples are available in the examples/ directory. We've deployed many of these examples at our public gallery; try them out!

Ready to learn more? Check out our docs!

Tutorial Inputs Plots Layout

FAQ

See the FAQ at our docs.

Contributing

We appreciate all contributions! You don't need to be an expert to help out. Please see CONTRIBUTING.md for more details on how to get started.

Questions? Reach out to us on Discord.

Community

We're building a community. Come hang out with us!

Subscribe to our newsletter