|
1 | | -The materials contained in this download are designed to complement the Real Python tutorial [Marimo: A Reactive, Reproducible Notebook](https://realpython.com/marimo-notebook-reactive-reproducible/). |
| 1 | +# Marimo: A Reactive, Reproducible Notebook |
2 | 2 |
|
3 | | -You should create a new folder named marimo on your computer and place each of these files inside it. You might also consider creating a [Python virtual environment](https://realpython.com/python-virtual-environments-a-primer/) within this folder. |
| 3 | +The materials contained in this download are designed to complement the Real Python tutorial [Marimo: A Reactive, Reproducible Notebook](https://realpython.com/marimo-notebook/). |
4 | 4 |
|
5 | | -Your download bundle contains the following files: |
| 5 | +## Installation |
6 | 6 |
|
7 | | -hypotenuse_calculator.py - This file contains the original hypotenuse_calculator code |
8 | | -hypotenuse_calculator_before_update.py - This file contains the code before any updating is attempted. The code has been deliberately placed out of order, however it runs cleanly. |
9 | | -hypotenuse_calculator_duplicate_variable.py - This file shows the effect of re-defining a variable. This file produces an error. |
10 | | -hypotenuse_calculator_after_update.py - This file contains the code after the `adjacent` variable was updated to `10`. This file runs cleanly. |
11 | | -hypotenuse_calculator_after_deletion.py - This file contains the code after the `opposite variable` was deleted. This file produces an error. |
| 7 | +Create a [Python virtual environment](https://realpython.com/python-virtual-environments-a-primer/), activate it, and install marimo along with its dependencies into it: |
12 | 8 |
|
13 | | -break_even_analysis_chart_code.py - This file contains the basic chart code. It will produce a break-even analysis for a fixed set of input data. |
14 | | -break_even_analysis_UI_elements.py - This file contains includes the four UI interface elements to allow the plot to be adjusted. |
15 | | -break_even_analysis_solution.py - This file contains a possible solution to the skills test. |
| 9 | +```sh |
| 10 | +$ python -m venv venv/ |
| 11 | +$ source venv/bin/activate |
| 12 | +(venv) $ python -m pip install -r requirements.txt |
| 13 | +``` |
16 | 14 |
|
17 | | -packages.py - This file contains the code used to demonstrate sandboxing. |
18 | | -quadratic.py - This file contains the marimo notebook version of the quadratic formula example. |
19 | | -equation.py - This file contains the Python script version of quadratic.py. |
| 15 | +## Contents |
20 | 16 |
|
21 | | -simultaneous_equations.py - This file contains the code used to demonstrate marimo's UI elements. |
22 | | -simultaneous_equations_ui.py - This file contains a possible solution to the challenge skills test. |
| 17 | +Your download bundle contains the following files: |
23 | 18 |
|
24 | | -hidden_state.ipynb - This file contains a Jupyter Notebook that can be used as a starting point for the investigation of its problems. You should adjust it as instructed in the tutorial. |
| 19 | +| Filename | Description | |
| 20 | +|--------------------------------------------|-------------------------------------------------------------------------------------------------| |
| 21 | +| `hypotenuse_calculator.py` | The original `hypotenuse_calculator` code. | |
| 22 | +| `hypotenuse_calculator_before_update.py` | The code before any updating is attempted. The code is out of order but runs cleanly. | |
| 23 | +| `hypotenuse_calculator_duplicate_variable.py` | Shows the effect of redefining a variable. This file produces an error. | |
| 24 | +| `hypotenuse_calculator_after_update.py` | The code after the `adjacent` variable was updated to `10`. Runs cleanly. | |
| 25 | +| `hypotenuse_calculator_after_deletion.py` | The code after the `opposite` variable was deleted. This file produces an error. | |
| 26 | +| `break_even_analysis_chart_code.py` | The basic chart code for a break-even analysis with fixed input data. | |
| 27 | +| `break_even_analysis_ui_elements.py` | Includes four UI interface elements to allow the plot to be adjusted. | |
| 28 | +| `break_even_analysis_solution.py` | A possible solution to the skills test. | |
| 29 | +| `packages.py` | The code used to demonstrate sandboxing. | |
| 30 | +| `quadratic.py` | The marimo notebook version of the quadratic formula example. | |
| 31 | +| `equation.py` | The Python script version of `quadratic.py`. | |
| 32 | +| `simultaneous_equations.py` | The code used to demonstrate marimo's UI elements. | |
| 33 | +| `simultaneous_equations_ui.py` | A possible solution to the challenge skills test. | |
| 34 | +| `hidden_state.ipynb` | This Jupyter Notebook is a starting point for investigating its problems, to be adjusted per tutorial. | |
0 commit comments