Back to Marimo

marimo - Documentation for the Reactive Python Notebook

docs/index.md

0.23.515.5 KB
Original Source
<style> .md-typeset h1 { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; } .md-content__button { display: none; } </style>

marimo: The Reactive Python Notebook

<p align="center" style="margin-top: 40px; margin-bottom: 40px;"> </p>

marimo is an open-source reactive Python notebook: run a cell or interact with a UI element, and marimo automatically runs dependent cells (or marks them as stale), keeping code and outputs consistent and preventing bugs before they happen. Every marimo notebook is stored as pure Python (Git-friendly), executable as a script, and deployable as an app; while stored as Python, marimo notebooks also have native support for SQL.

/// admonition | Built from the ground up type: tip

marimo was built from the ground up to solve <a href="faq.html#faq-jupyter">well-known problems associated with traditional notebooks</a>. ///

Get started instantly with molab, our free online notebook. Or get started locally by installing marimo with your favorite package manager:

/// tab | install with pip

bash
pip install marimo && marimo tutorial intro

///

/// tab | install with uv

bash
uv add marimo && uv run marimo tutorial intro

///

/// tab | install with conda

bash
conda install -c conda-forge marimo && marimo tutorial intro

///

Developer experience is core to marimo, with an emphasis on reproducibility, maintainability, composability, and shareability.

Highlights

A reactive programming environment

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

A reactive programming environment. Run a cell and marimo reacts by automatically running the cells that reference its variables, eliminating the error-prone task of manually re-running cells. Delete a cell and marimo scrubs its variables from program memory, eliminating hidden state.

<video autoplay muted loop playsinline width="700px" align="center"> <source src="/_static/reactive.mp4" type="video/mp4"> <source src="/_static/reactive.webm" type="video/webm"> </video>

<a name="expensive-notebooks"></a>

Compatible with expensive notebooks. marimo lets you configure the runtime to be lazy, marking affected cells as stale instead of automatically running them. This gives you guarantees on program state while preventing accidental execution of expensive cells.

Synchronized UI elements. Interact with UI elements like sliders, dropdowns, dataframe transformers, and chat interfaces, and the cells that use them are automatically re-run with their latest values.

<video autoplay muted loop playsinline width="700px" align="center"> <source src="/_static/readme-ui.mp4" type="video/mp4"> <source src="/_static/readme-ui.webm" type="video/webm"> </video>

Interactive dataframes. Page through, search, filter, and sort millions of rows blazingly fast, no code required.

<video autoplay muted loop playsinline width="700px" align="center"> <source src="/_static/docs-df.mp4" type="video/mp4"> <source src="/_static/docs-df.webm" type="video/webm"> </video>

Generate cells with data-aware AI. Collaborate on marimo notebooks with your favorite agent, such as Claude Code, Codex, or OpenCode, using marimo pair. Or, generate code in the marimo editor with an AI assistant that is highly specialized for working with data, with context about your variables in memory. Customize the system prompt, bring your own API keys, or use local models.

<video autoplay muted loop playsinline width="700px" align="center"> <source src="/_static/readme-generate-with-ai.mp4" type="video/mp4"> </video>

Query data with SQL. Build SQL queries that depend on Python values and execute them against dataframes, databases, lakehouses, CSVs, Google Sheets, or anything else using our built-in SQL engine, which returns 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 tell dynamic stories that depend on Python data.

Built-in package management. marimo has built-in support for all major package managers, letting you install packages on import. marimo can even serialize package requirements in notebook files, and auto install them in isolated venv sandboxes.

Deterministic execution order. Notebooks are executed in a deterministic order, 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 by statically analyzing your code.

Batteries-included. marimo comes with GitHub Copilot, AI assistants, Ruff code formatting, HTML export, fast code completion, a VS Code extension, an interactive dataframe viewer, and many more quality-of-life features.

Quickstart

The marimo concepts playlist on our YouTube channel gives an overview of many features.

Installation. In a terminal, run

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

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

bash
pip install marimo[recommended]

Create notebooks.

Create or edit notebooks with

bash
marimo edit

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

bash
marimo run your_notebook.py
<video autoplay muted loop playsinline width="450px" align="center" style="border-radius: 8px"> <source src="/_static/docs-model-comparison.mp4" type="video/mp4"> <source src="/_static/docs-model-comparison.webm" type="video/webm"> </video>

Execute as scripts. Execute a notebook as a script at the command line:

bash
python your_notebook.py

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

bash
marimo convert your_notebook.ipynb > your_notebook.py

or use our web interface.

Tutorials. List all tutorials:

bash
marimo tutorial --help

Share cloud-based notebooks. Use molab, a cloud-based marimo notebook service similar to Google Colab, to create and share notebook links.

Questions?

See our FAQ.

Learn more

marimo is easy to get started with, with lots of room for power users. For example, here's an embedding visualizer made in marimo (try the notebook live on molab!):

<video autoplay muted loop playsinline width="700px" align="center"> <source src="/_static/embedding.mp4" type="video/mp4"> <source src="/_static/embedding.webm" type="video/webm"> </video>

Check out our guides, usage examples, and our gallery to learn more.

<table border="0"> <tr> <td> <a target="_blank" href="getting_started/key_concepts"> <video autoplay muted loop playsinline style="max-height: 150px; width: auto; display: block"> <source src="/_static/reactive.mp4" type="video/mp4"> <source src="/_static/reactive.webm" type="video/webm"> </video> </a> </td> <td> <a target="_blank" href="api/inputs/"> <video autoplay muted loop playsinline style="max-height: 150px; width: auto; display: block"> <source src="/_static/readme-ui.mp4" type="video/mp4"> <source src="/_static/readme-ui.webm" type="video/webm"> </video> </a> </td> <td> <a target="_blank" href="guides/working_with_data/plotting"> <video autoplay muted loop playsinline style="max-height: 150px; width: auto; display: block"> <source src="/_static/docs-intro.mp4" type="video/mp4"> <source src="/_static/docs-intro.webm" type="video/webm"> </video> </a> </td> <td> <a target="_blank" href="api/layouts/"> <video autoplay muted loop playsinline style="max-height: 150px; width: auto; display: block"> <source src="/_static/outputs.mp4" type="video/mp4"> <source src="/_static/outputs.webm" type="video/webm"> </video> </a> </td> </tr> <tr> <td> <a target="_blank" href="getting_started/key_concepts"> Tutorial </a> </td> <td> <a target="_blank" href="api/inputs/"> Inputs </a> </td> <td> <a target="_blank" href="guides/working_with_data/plotting"> Plots </a> </td> <td> <a target="_blank" href="api/layouts/"> Layout </a> </td> </tr> <tr> <td> <a target="_blank" href="https://molab.marimo.io/notebooks/nb_TWVGCgZZK4L8zj5ziUBNVL">
  </a>
</td>
<td>
  <a target="_blank" href="https://molab.marimo.io/notebooks/nb_WuoXgs7mjg5yqrMxJXjRpF">
    
  </a>
</td>
<td>
  <a target="_blank" href="https://molab.marimo.io/notebooks/nb_vXxD13t2RoMTLjC89qdn6c">
    
  </a>
</td>
<td>
  <a target="_blank" href="https://molab.marimo.io/notebooks/nb_XpXx8MX99dWAjn4k1b3xiU">
    
  </a>
</td>
</tr> </table>

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!

A NumFOCUS affiliated project. marimo is a core part of the broader Python ecosystem and is a member of the NumFOCUS community, which includes projects such as NumPy, SciPy, and Matplotlib.

Inspiration ✨

marimo is a reinvention 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, for better minds. With marimo, we hope to provide the Python community with a better programming environment to do research and communicate it; to experiment with code and share it; to learn computational science and teach it.

Our inspiration comes from many places and projects, especially Pluto.jl, ObservableHQ, and Bret Victor's essays. marimo is part of a greater movement toward reactive dataflow programming. From IPyflow, streamlit, TensorFlow, PyTorch, JAX, and React, the ideas of functional, declarative, and reactive programming are transforming a broad range of tools for the better.

<p align="right"> </p>