nmaci

Automated tools for building and verifying NMA tutorial materials.

Installation

pip install git+https://github.com/OleBialas/nmaci@main

Usage

nmaci <command> [args]

Command	Description
process-notebooks	Execute notebooks, extract solutions, create student/instructor versions
verify-exercises	Check exercise cells match solution cells
lint-tutorial	Run flake8/pyflakes over notebook code cells
generate-readmes	Auto-generate tutorial README.md files
generate-book	Build Jupyter Book from materials.yml
generate-book-dl	Build Jupyter Book (Deep Learning variant)
generate-book-precourse	Build Jupyter Book (Precourse variant)
select-notebooks	Filter which notebooks to process
make-pr-comment	Generate PR comment with Colab badges and lint report
find-unreferenced	Identify unused solution images/scripts
extract-links	Extract video/slide links from notebooks
parse-html	Check HTML build output for errors

Development

git clone https://github.com/OleBialas/nmaci
cd nmaci
uv sync --extra dev
uv run pytest tests/

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Zoltan 💻 ⚠️ 🚧

Ole Bialas 💻 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!