PyPNM documentation hub

Use this page to grab the right guide no matter where you are in the journey—installing, configuring, operating, or contributing.

New to PyPNM? (Start here)

• Project overview - why PyPNM exists plus installer basics.
• Install flow - clone, run ./install.sh, and bring up the FastAPI stack.
• Docker install & usage - helper script, manual tarball flow, offline notes, prerequisites.
• Docker commands - common compose/logs/config/restart helpers for PyPNM.
• Topology guide - pick a PNM file retrieval method before you touch system.json.
• System configuration quick tour - understand the interactive helpers before editing the config.

Configure and operate

• System configuration reference - every field in src/pypnm/settings/system.json.
• PNM file retrieval helpers - local, TFTP, SCP/SFTP workflows and setup scripts.
• CLI/service usage - run the FastAPI launcher and related scripts.
• Operational tools - log collection, capture orchestration, and automation helpers.
• Scripts - one-liners in scripts/ for installs, secrets, CI helpers.
• Demo mode guide - how the sample data environment is staged and how to reset it.

Develop and automate

• API reference - REST endpoints plus Python helper library docs.
• Examples - runnable walkthroughs hitting the API.
• Tests - how to execute and extend the automated test suites.

Release and support

• Release strategy - versioning, tagging, and publishing flow.
• Issues and support bundles - how to report bugs, gather diagnostics, and share logs.
• Security - responsible disclosure guidelines.

Need more context?

• Style guide - guidelines for writing or updating documentation.
• Project roadmap / README next steps - suggestions on what to explore after installation.