Monata Documentation

Complete documentation for the Monata circuit simulation framework.

📚 What's Inside

• Getting Started - Installation and first Monata library
• User Guide - Monata workflow: libraries, cells, views, models, simulation, results, sweeps, optimization
• Toolchain - Public external-tool boundary, lizhangmai/skills agent-managed local conda-channel setup, pixi environments, and ngspice/Xyce/OpenVAF/ADMS details
• Tutorials - Step-by-step guides (coming soon)
• Examples - Example circuits and scripts (coming soon)
• Reference - Model compatibility, BSIM background, and technical specifications
• Maintainers - Roadmap, contribution policy, compliance notes, release notes, and packaging guidance

🚀 Quick Start

Prerequisites

Install pixi:

curl -fsSL https://pixi.sh/install.sh | bash

Build and Preview

cd src/monata-docs

# First time setup
pixi install

# Development mode (auto-rebuild on file changes)
pixi run dev

# Visit http://localhost:8000

🛠 Common Tasks

pixi run build            # Build local HTML documentation
pixi run serve            # Serve on localhost:8000
pixi run clean            # Clean build artifacts
pixi run linkcheck        # Check for broken links
pixi run dev              # Development mode (recommended)
pixi task list            # Show all available tasks

🌐 Online Documentation

Documentation is automatically published via Read the Docs:

Main site: https://monata-docs.readthedocs.io (coming soon)

Setup Read the Docs

1. Visit https://readthedocs.org and login with GitHub
2. Import the lizhangmai/monata-docs repository
3. Use the .readthedocs.yml file from the repository root
4. Build is automatic via the native Read the Docs Sphinx workflow

Each push triggers an HTML documentation rebuild plus all Read the Docs offline formats.

📝 Contributing

Adding/Editing Documentation

1. Edit .md files in docs/user-guide/, docs/toolchain/, docs/reference/, etc.
2. Use MyST Markdown syntax
3. Preview locally: pixi run dev
4. Commit and push

Reporting Issues

Open an issue with the documentation label in the main repository.

📂 Project Structure

monata-docs/
├── pixi.toml              # Pixi configuration and tasks
├── pixi.lock              # Locked dependencies (auto-generated)
├── .readthedocs.yml       # Read the Docs configuration
├── docs/
│   ├── conf.py            # Sphinx configuration
│   ├── index.md           # Main index
│   ├── getting-started/   # Installation and first steps
│   ├── user-guide/        # Monata workflow guides
│   ├── toolchain/         # Backend and model compiler guides
│   ├── tutorials/         # Tutorials
│   ├── examples/          # Examples
│   ├── reference/         # Reference docs
│   └── maintainers/       # Maintainer-only process docs
└── README.md              # This file

🔗 Links

• Main Repository: https://github.com/lizhangmai/monata
• Monata Package: https://github.com/lizhangmai/monata/tree/main/src/monata
• MyST Syntax Guide: https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html
• Sphinx Documentation: https://www.sphinx-doc.org/
• Furo Theme: https://pradyunsg.me/furo/

📄 License

Documentation is licensed under CC BY-SA 4.0.