marimo README

The project's README from github.com/marimo-team/marimo. As one markdown file: README.md.

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

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

Highlights.

pip install marimo && marimo tutorial intro

Get started instantly with molab, our free online notebook. Or 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.

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.

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.

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

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.

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, a PyCharm plugin, 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

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]"

Create notebooks.

Create or edit notebooks with

marimo edit

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

marimo run your_notebook.py

Execute as scripts. Execute a notebook as a script 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

Share 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 (try the notebook live on molab!):

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!

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.

Finally, we would like to acknowledge Bennet Meyers and David Chassin for believing in marimo from the very beginning: this work was supported in part by U.S. DOE Office of Critical Minerals and Energy Innovation (CMEI) Integrated Energy Systems Office (IESO), Agreement 34368.

marimo (marimo-team/marimo)

Searching Database…

23.2K ·GitHub
这是什么?一个响应式的 Python 笔记本:运行某个单元格或操作界面元素时,相关的单元格会自动重新运行,让代码和输出保持一致。笔记本就是纯 Python 文件,既可以当脚本运行,也可以部署成网页应用。
它和 Jupyter 有什么不同?Jupyter 把笔记本存成 JSON,手动反复运行单元格会积累隐藏状态。marimo 则根据变量引用关系按确定的顺序执行单元格,会把已删除的单元格从内存中清除,并保存为对 git 友好的 .py 文件。
我怎么把它跑起来?先用 pip 安装,然后运行 'marimo edit' 会在浏览器里打开一个笔记本,'marimo run' 则把它作为网页应用来运行。如果不想安装任何东西,可以在 molab(该项目的免费云端笔记本服务)上直接试用。
除了 Python 之外还需要装什么?只需要 Python。基础的 pip 安装就能使用笔记本功能;扩展安装还会解锁 SQL 单元格和 AI 补全。内置的包管理功能会在导入时自动安装所需的包,还能在隔离的 venv 沙箱里自动安装依赖。
如果某个单元格要跑一个小时,随便改一点就得把整个笔记本重新跑一遍吗?不用——你可以把运行时设置成惰性(lazy)模式,受影响的单元格只会被标记为过期,而不会立刻执行,这样耗时的单元格只在你明确运行它时才会跑。
这是给数据科学家用的,还是面向所有 Python 开发者?适合所有用 Python 做计算工作的人——数据科学、机器学习、科研、教学。marimo 是一个 NumFOCUS 附属项目,适合做研究、分享实验和讲授计算科学。
我用什么操作系统有关系吗?它是通过 pip 安装的 Python 工具,macOS、Linux 和 Windows 都能用,编辑器界面就在浏览器里运行。部署后的笔记本甚至可以通过 WASM 完全在浏览器里运行。
这里的 AI-native 是什么意思——我的代码会被发到云端模型吗?只有你主动选择才会。你可以通过 marimo pair 把 Claude Code、Codex 或 OpenCode 这类编程代理接上笔记本,也可以用自己的 API 密钥或本地模型使用内置助手。
它只能用 Python 吗,还是也能用 SQL 查数据?SQL 是一等公民:内置引擎可以查询 dataframe、数据库、数据仓库、lakehouse、CSV 文件和 Google Sheets,结果以 Python dataframe 的形式返回。查询还可以依赖 Python 变量,保存下来的笔记本仍然是纯 Python。
我能把笔记本分享给不该看到代码的人吗?可以——'marimo run' 会把它部署成交互式网页应用,Python 代码被隐藏且不可编辑。滑块、下拉框、dataframe 转换器这类界面元素无需回调就能正常工作,笔记本还可以导出成幻灯片。
笔记本里的代码能像普通 Python 模块那样复用和测试吗?可以——函数和类可以从一个笔记本导入到另一个笔记本,还能对笔记本运行 pytest。
我有一堆旧的 Jupyter 笔记本——必须重写吗?不用——一条 CLI 命令或网页界面就能把 Jupyter 笔记本自动转换成 marimo。
Size
252.4 MB
Stars
23.2K
Age
3y
Commits · 90 Days