This page explains how to get started with MAX example notebooks, and this repo directory contains notebooks that demonstrate some of MAX features.
If you're not familiar with Jupyter notebooks, they're files that allow you to create documents with live code, equations, visualizations, and explanatory text. They're basically documents with executable code blocks, making them great for sharing code experiments and programming tutorials.
Visual Studio Code is a great environment for programming with Jupyter notebooks. Especially if you're developing with MAX on a remote system, using VS Code is ideal because it allows you to edit and interact with notebooks on the remote machine where you've installed MAX.
All you need is MAX (via Magic) and the Jupyter VS Code extension:
-
Install Visual Studio Code and the Jupyter extension.
-
Open any
.ipynb
file in this repo and start running the code.
You can also run MAX notebooks in a local instance of JupyterLab. The following is just a quick setup guide for Linux users, but it might not work with your system (these instructions don't support remote access to the JupyterLab). For more details about using JupyterLab, see the complete JupyterLab installation guide.
You can use either Magic or conda.
If you have magic
you can run the following
command to launch JupyterLab from this directory:
magic run jupyter lab
After a moment, it will open a browser window with JupterLab running.
Create a Conda environment, activate that enviroment, and install JupyterLab.
# Create a Conda environment if you don't have one
conda create -n max-repo
# Activate the environment
conda env update -n max-repo -f environment.yml --prune
# run JupyterLab
conda run -n max-repo jupyter lab
After a moment, it will open a browser window with JupterLab running.
The left nav bar should show all the notebooks in this directory.
Open any .ipynb
file and start running the code.