Repository files navigation

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

Docs ·Discord ·Examples ·Gallery ·YouTube

English |简体中文 |日本語 |Español

marimo is a reactive Python notebook: run a cell or interact with a UIelement, and marimo automatically runs dependent cells (ormarks them as stale), keeping code and outputsconsistent. marimo notebooks are stored as pure Python (with first-class SQL support), executable as scripts,and deployable as apps.

Highlights.

• 🚀batteries-included: replacesjupyter,streamlit,jupytext,ipywidgets,papermill, and more
• ⚡️reactive: run a cell, and marimo reactivelyruns all dependent cells ormarks them as stale
• 🖐️interactive:bind sliders, tables, plots, and more to Python — no callbacks required
• 🐍git-friendly: stored as.py files
• 🛢️designed for data: query dataframes, databases, warehouses, or lakehouseswith SQL, filter and searchdataframes
• 🤖AI-native:generate cells with AI tailored for data work
• 🔬reproducible:no hidden state, deterministic execution,built-in package management
• 🏃executable:execute as a Python script, parameterized by CLI args
• 🛜shareable:deploy as an interactive web app orslides,run in the browser via WASM
• 🧩reusable:import functions and classes from one notebook to another
• 🧪testable:run pytest on notebooks
• ⌨️a modern editor:GitHub Copilot,AI assistants, vim keybindings, variable explorer, andmore

pipinstallmarimo&&marimotutorialintro

Try marimo atour online playground, which runs entirely in the browser!

Jump to thequickstart for a primer on our CLI.

marimo guarantees your notebook code, outputs, and program state are consistent. Thissolves many problems associated with traditional notebooks like Jupyter.

A reactive programming environment.Run a cell and marimoreacts by automatically running the cells thatreference its variables, eliminating the error-prone task of manuallyre-running cells. Delete a cell and marimo scrubs its variables from programmemory, eliminating hidden state.

Compatible with expensive notebooks. marimo lets youconfigure the runtimeto belazy,marking affected cells as stale instead of automatically running them. Thisgives you guarantees on program state while preventing accidental execution ofexpensive cells.

Synchronized UI elements. Interact withUIelements likesliders,dropdowns,dataframetransformers, andchatinterfaces, and the cells thatuse them are automatically re-run with their latest values.

Interactive dataframes.Page through, search, filter, andsortmillions of rows blazingly fast, no code required.

Generate cells with data-aware AI.Generate code with an AIassistant that is highlyspecialized for working with data, with context about your variables in memory;zero-shot entire notebooks.Customize the system prompt, bring your own API keys, or use local models.

Query data with SQL. BuildSQL queriesthat depend on Python values and execute them against dataframes, databases, lakehouses,CSVs, Google Sheets, or anything else using our built-in SQL engine, whichreturns the result as a Python dataframe.

Your notebooks are still pure Python, even if they use SQL.

Dynamic markdown. Use markdown parametrized by Python variables to telldynamic stories that depend on Python data.

Built-in package management. marimo has built-in support for all majorpackage managers, letting youinstall packages on import. marimo can evenserialize packagerequirementsin notebook files, and auto install them inisolated venv sandboxes.

Deterministic execution order. Notebooks are executed in a deterministicorder, based on variable references instead of cells' positions on the page.Organize your notebooks to best fit the stories you'd like to tell.

Performant runtime. marimo runs only those cells that need to be run bystatically analyzing your code.

Batteries-included. marimo comes with GitHub Copilot, AI assistants, Ruffcode formatting, HTML export, fast code completion, aVS Codeextension,an interactive dataframe viewer, andmany morequality-of-life features.

Themarimo conceptsplayliston ourYouTube channel gives anoverview of many features.

Installation. In a terminal, run

pip install marimo# or conda install -c conda-forge marimomarimo tutorial intro

To install with additional dependencies that unlock SQL cells, AI completion, and more,run

pip install marimo[recommended]

Create notebooks.

Create or edit notebooks with

marimo edit

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

marimo run your_notebook.py

Execute as scripts. Execute a notebook as a script at thecommand line:

python your_notebook.py

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

marimo convert your_notebook.ipynb> your_notebook.py

or use ourweb interface.

Tutorials.List all tutorials:

marimo tutorial --help

See theFAQ at our docs.

marimo is easy to get started with, with lots of room for power users.For example, here's an embedding visualizer made in marimo(video):

Check out ourdocs,usage examples, and ourgallery to learn more.

Tutorial	Inputs	Plots	Layout

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

Questions? Reach out to uson Discord.

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

• 🌟Star us on GitHub
• 💬Chat with us on Discord
• 📧Subscribe to our Newsletter
• ☁️Join our Cloud Waitlist
• ✏️Start a GitHub Discussion
• 🦋Follow us on Bluesky
• 🐦Follow us on Twitter
• 🎥Subscribe on YouTube
• 🕴️Follow us on LinkedIn

A NumFOCUS affiliated project. marimo is a core part of the broader Pythonecosystem and is a member of the NumFOCUS community, which includes projectssuch as NumPy, SciPy, and Matplotlib.

marimo is areinvention of the Python notebook as a reproducible, interactive,and shareable Python program, instead of an error-prone JSON scratchpad.

We believe that the tools we use shape the way we think — better tools, forbetter minds. With marimo, we hope to provide the Python community with abetter programming environment to do research and communicate it; to experimentwith code and share it; to learn computational science and teach it.

Our inspiration comes from many places and projects, especiallyPluto.jl,ObservableHQ, andBret Victor's essays. marimo is part ofa greater movement toward reactive dataflow programming. FromIPyflow,streamlit,TensorFlow,PyTorch,JAX, andReact, the ideas of functional,declarative, and reactive programming are transforming a broad range of toolsfor the better.