//marimobytobiasdiez

marimo

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

0
0
0

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

Docs · Discord · Examples · Gallery · YouTube

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

discord Pepy Total Downloads Conda Downloads

undefinedmarimo is a 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. marimo notebooks are stored as pure Python (with first-class SQL support), executable as scripts,
and deployable as apps.

undefinedHighlights.

pip install marimo && marimo tutorial intro

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

Jump to the quickstart for a primer on our CLI.

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.

undefinedA reactive programming environment.undefined
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.

undefinedCompatible 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.

undefinedSynchronized 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.

undefinedInteractive dataframes. Page through, search, filter, and
sort

millions of rows blazingly fast, no code required.

undefinedGenerate cells with data-aware AI. Generate code with an AI
assistant
that is highly
specialized 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.

undefinedQuery 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.

undefinedDynamic markdown. Use markdown parametrized by Python variables to tell
dynamic stories that depend on Python data.

undefinedBuilt-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.

undefinedDeterministic 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.

undefinedPerformant runtime. marimo runs only those cells that need to be run by
statically analyzing your code.

undefinedBatteries-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.

undefinedInstallation. In a terminal, run

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

pip install "marimo[recommended]"

undefinedCreate notebooks.undefined

Create or edit notebooks with

marimo edit

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

marimo run your_notebook.py

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

python your_notebook.py

undefinedAutomatically 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.

undefinedTutorials.undefined
List all tutorials:

marimo tutorial --help

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

Questions?

See the FAQ at our docs.

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
(video):

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

Tutorial Inputs Plots Layout

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!

undefinedA 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.

[beta]v0.14.0