Skip to content

README.md

Latest commit

 

History

History
84 lines (49 loc) · 5 KB

README.md

File metadata and controls

84 lines (49 loc) · 5 KB
Raw

Marimo notebooks

FICO® Xpress Python example notebooks built with marimo, a reactive, browser-based notebook format.

Just want to take a look, not run code? See the live read-only gallery, a static export of every notebook below, no installation or Codespace setup needed. Each page is a static snapshot: sliders and other interactive controls will not respond. Follow the steps below to run a notebook interactively.

Getting started

Running marimo notebooks in GitHub Codespaces

Please note that the creation of the codespace may take 3-4 minutes; we ask for your patience during this step.

  1. On the repository's GitHub page, click Code, then open the Codespaces tab.

  2. Click the ... icon next to Create codespace on master and select New with options.

    create codespace on master

  3. In the Dev container configuration dropdown, choose Marimo Xpress Notebooks (not the default "Jupyter" configuration).

    select dev container configuration

  4. Click Create codespace. Building the environment takes about 3-4 minutes. You can follow progress in the terminal panel at the bottom; the setup is finished once you see a message confirming marimo has started and is listening on port 2718.

    terminal showing marimo startup progress

  5. At some point during setup, VS Code may show a "Do you trust the authors of the files in this folder?" popup. This is a one-time security prompt from VS Code itself (not something this repository controls), and it is expected. Click Yes, I trust the authors to continue.

    workspace trust popup

  6. Once the port is ready, VS Code shows a notification with an Open in Browser button. Click it to open the marimo home page in a new browser tab.

    port forwarded notification with Open in Browser button

    If you miss the notification or it disappears, open the Ports tab next to the terminal instead. You should see port 2718 listed with the label marimo. Click the link under the Forwarded Address column for that row to open it in your browser (the Add Port button is for forwarding a new port and has no effect here, since port 2718 is already forwarded).

    Ports tab with port 2718 forwarded

  7. Once the tab opens, you will see the marimo home page: a grid of notebook thumbnails, each with a title and short subtitle, similar to the screenshot below.

    marimo home page with notebook tiles

  8. Click any notebook, for example Project Assignment. Every cell runs automatically as soon as the notebook opens. Try moving one of the sliders, for example the problem-size slider, and watch every dependent cell re-run automatically, updating the results table and chart in real time.

    assignment notebook controls with sliders

Running marimo notebooks locally

If you would rather not use Codespaces, you can run the notebooks on your own machine instead.

Prerequisites: Python 3.13+ and Git installed.

  1. Clone the repository and move into the marimo/ folder:

    git clone https://github.com/fico-xpress/python-notebooks.git
cd python-notebooks/marimo

  2. Install the notebook dependencies. Using a virtual environment is optional but recommended so these packages don't clash with anything else on your machine:

    python -m venv .venv
.venv\Scripts\activate      # on Windows
source .venv/bin/activate   # on macOS/Linux

pip install -r requirements.txt

  3. Launch any notebook with marimo edit (opens the notebook in editable mode, so you can also modify the code) or marimo run (opens it in read-only run mode, matching the Codespaces experience where all cells auto-run and only the modelling code stays visible):

    marimo edit 01_assignment.py
# or, to browse all notebooks from a single home page like in Codespaces:
marimo run .

    Either command starts a local server and should open a new browser tab automatically at http://localhost:2718. If it doesn't, copy that URL into your browser manually.

Legal and license requirements

See Legal and license requirements in the main README.