Documentation

Everything you need to learn the WEEMS workspace

Start here to understand how projects, notebooks, canvas workflows, materials, and local compute fit together. Each guide is structured as a practical walkthrough rather than a detached reference dump.

Start with Getting Started Open schema docs

Introduction

Getting Started

An introduction to WEEMS, its main workspace surfaces, and how projects, canvas, notebooks, and blocks fit together.

Workspace

Projects

A chapter-style introduction to WEEMS Projects, including the dashboard, project creation, workspace setup, analysis, and notebook export.

Canvas

Understand the canvas workspace, block workflows, notebook structure, sidebar navigation, files, and table of contents behavior.

Local Compute

A step-by-step walkthrough for downloading local setup files, starting the Docker adapter, syncing a local artifact, and running computations on your own machine.

Reference

Materials

A guided path into materials documentation with a clear handoff to the canonical schema docs and import reference.

More routes

Supporting references

This hub complements the public docs with the materials schema reference and the blog index so search engines can understand the documentation structure.

Blog Contact Schema docs