greenray-aio 0.5.0__tar.gz

greenray_aio-0.5.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Rehmana Younis
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

greenray_aio-0.5.0/NOTICE

@@ -0,0 +1,10 @@
+GreenRay AIO
+Copyright 2026 Rehmana Younis
+
+Licensed under the Apache License, Version 2.0.
+
+GreenRay AIO is an independent study tool. It is not affiliated with, endorsed by
+or sponsored by NVIDIA Corporation. NVIDIA, DGX, Base Command Manager, NCP-AIO and
+related names are trademarks of NVIDIA Corporation and are used only to describe
+the certification this tool helps you prepare for. Every node, GPU, switch and log
+in GreenRay AIO is simulated; no NVIDIA software is included.

greenray_aio-0.5.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.4
+Name: greenray-aio
+Version: 0.5.0
+Summary: GreenRay AIO: hands-on lab simulator and mock exam for the NVIDIA NCP-AIO (AI Operations) certification
+Keywords: ncp-aio,nvidia-certification,ai-infrastructure,ai-operations,exam-prep,slurm,kubernetes,gpu-operator,base-command-manager,dgx,hpc,simulator
+Author: Rehmana Younis
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Education
+Classifier: Topic :: System :: Clustering
+Classifier: Topic :: System :: Systems Administration
+Requires-Dist: prompt-toolkit>=3.0.43
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/RehmanaYounis/greenray-aio
+Project-URL: Issues, https://github.com/RehmanaYounis/greenray-aio/issues
+Description-Content-Type: text/markdown
+
+# GreenRay AIO
+
+**Hands-on lab simulator and mock exam for the NVIDIA-Certified Professional: AI Operations (NCP-AIO) exam.**
+
+GreenRay AIO drops you into a broken or half-configured **4-node DGX H100 cluster managed by Base Command Manager (BCM)**. You investigate and fix it with the same commands you'd use on real systems:
+- `nvidia-smi` and `dcgmi`
+- Slurm
+- `kubectl` and `helm` with the GPU Operator
+- `cmsh`
+- InfiniBand tools and NCCL tests
+- Docker and NGC containers
+
+`check` grades the end state of the cluster, not whether you typed a particular command.
+
+- **39 incident and task scenarios** covering every topic of the exam blueprint ([docs/COVERAGE.md](docs/COVERAGE.md))
+- **Incident mode**: only the incident report is shown, and the root cause stays hidden until the debrief
+- **`explain <command>`** for learning tools as you need them, plus progressive hints and a debrief after every lab
+- **Feels like a real node**: `--help` and `man` pages, `nano`/`vim` (your real editor), `cd` with tab completion of paths, command history, `watch`, live `dmon` samples, a coloured prompt and real-tool colours
+- **Full mock exam** in the current format: 30 questions plus 3 hands-on labs in 120 minutes (per NVIDIA's exam page; re-check before booking)
+- Runs anywhere Python runs: Linux, WSL, macOS or Windows. **No GPU needed.**
+
+```
+root@bcm-head:~# ssh dgx-03
+root@dgx-03:~# dmesg | grep -i xid
+[ 8812.402113] NVRM: Xid (PCI:0000:5d:00): 79, pid=0, GPU has fallen off the bus.
+root@dgx-03:~# nvidia-smi
+Unable to determine the device handle for GPU00000000:5D:00.0: Unknown Error
+...
+root@dgx-03:~# check
+  PASS  you read the kernel log on dgx-03
+  ....  2 more success criteria not met yet
+```
+
+> GreenRay AIO is an independent study tool. It is **not affiliated with, endorsed by or sponsored by NVIDIA**. NVIDIA, DGX, NCP-AIO and related names are trademarks of NVIDIA Corporation, used here only to describe the exam this tool helps you prepare for. Every node, GPU and log is simulated.
+
+## Install
+
+Pick one. A GPU is **not** required.
+
+**With uv or pipx** (any OS with Python 3.10+):
+
+```bash
+uv tool install greenray-aio      # or: pipx install greenray-aio
+greenray
+```
+
+**With Docker** (nothing to install):
+
+```bash
+docker run -it --rm -v greenray:/home/lab/.greenray ghcr.io/rehmanayounis/greenray-aio
+```
+
+The named volume keeps your progress between runs.
+
+**From source** (to contribute):
+
+```bash
+git clone https://github.com/RehmanaYounis/greenray-aio.git
+cd greenray-aio && uv sync && uv run greenray
+```
+
+Use WSL rather than PowerShell on Windows for the best terminal experience. `greenray doctor` prints your environment when something looks wrong.
+
+Developer commands (see [CONTRIBUTING.md](CONTRIBUTING.md)):
+
+```bash
+uv run pytest            # test suite (add --cov for coverage)
+uv run ruff check .      # lint
+uv run ruff format .     # format
+uv run mypy              # type checks
+uv build                 # wheel + sdist
+docker build -t greenray-aio .
+```
+
+## Use
+
+Installed with uv tool, pipx or Docker, the command is `greenray …`. From a source checkout use `uv run greenray …`.
+
+| Command | What it does |
+| --- | --- |
+| `greenray` | Interactive menu (`--no-color` for plain output) |
+| `greenray list` | All scenarios by exam domain, with your pass marks |
+| `greenray incident [-d DOMAIN] [-t TOPIC]` | **Investigate a random incident.** Only the incident report is shown; the scenario's id, title and success criteria stay hidden until the debrief. `-t` takes a scenario tag such as `slurm`, `kubernetes`, `bcm`, `mig` or `infiniband` |
+| `greenray incident --id <id>` | Retry a specific scenario as an incident (for a fresh independent attempt) |
+| `greenray lab <id>` | Start a hands-on scenario in guided mode (title, objectives and hints visible) |
+| `greenray sandbox` | A healthy cluster to explore freely |
+| `greenray mock` | **Full mock exam:** 30 questions + 3 labs (one Slurm, one Kubernetes, one BCM) in 120 minutes, with no hints. Graded at the end |
+| `greenray exam` | Question drill: 60 questions in 120 minutes, weighted 31/23/23/23 like the blueprint |
+| `greenray exam -n 20 -m 40 -d "Administration"` | Domain drill |
+| `greenray progress` | Passed labs, exam history, weakest domain |
+| `greenray validate` | Self-test: every scenario is solvable by its reference solution |
+| `greenray doctor` | Version, Python, terminal, editor, solutions source and progress path |
+
+Inside a lab, these meta-commands are available alongside the simulated cluster commands:
+
+| Command | What it does |
+| --- | --- |
+| `task` | Show the briefing again |
+| `check` | Grade your work. In incident mode, unmet criteria are counted but not named |
+| `explain <cmd>` | What a command is for, its useful options, what to look for in its output, and common errors. It never describes a scenario's fix |
+| `hint` | Show the next hint. Hints get more specific, and the last one asks for confirmation because it is close to the answer |
+| `objectives` | Incident mode only: reveal the success criteria (this attempt then counts as guided) |
+| `retry` | Incident mode only: start a fresh attempt (cluster, timer, hints and objectives reset) |
+| `solution` | Give up and see the answer, explanation and edge cases |
+| `reset` | Put the cluster back to the broken state. Same attempt: hints used and the timer carry over |
+| `commands` | List the simulated tools |
+| `quit` | Leave the lab |
+
+When you pass, you get the **debrief**: the reference solution, why it works, the edge cases and exam traps, **your own commands** for comparison, and a related scenario to practise next. Read it even when you passed. Ctrl-C cancels the current line, as in bash.
+
+### Guided or independent
+
+`greenray progress` shows three counts per domain:
+- **passed**
+- **without hints**
+- **as an incident, unguided**: passed in incident mode with no hints and no revealed objectives
+
+A good routine is to learn a topic in guided mode first, then prove it with `greenray incident -t <topic>`.
+
+### What the grader can and cannot judge
+
+- It grades the **end state** of the cluster, so any valid fix passes. For example, `nvidia-smi -pm 1` and `systemctl enable --now nvidia-persistenced` are both accepted for persistence mode.
+- Evidence checks confirm that you **ran** the diagnostic commands. Except where a check says otherwise, they do **not** check that you ran them before changing anything. Diagnose first anyway; the debrief reminds you.
+- It does not generally detect unnecessary changes. Only some scenarios guard against specific harmful ones, such as raising power limits to hide a thermal fault, or killing a user's job.
+- If a command ever crashes inside the simulator (a bug), the cluster is restored to its state before that command and you are told so.
+
+Progress is stored in `~/.greenray/progress.json` on your machine (set `GREENRAY_HOME` to move it). Progress from the older `~/.aiolab` folder is copied over automatically the first time you run it.
+
+## The simulated cluster
+
+| Host | Role |
+| --- | --- |
+| `bcm-head` | BCM head node (`cmsh`), Slurm controller, Kubernetes control plane, NGC CLI |
+| `dgx-01` … `dgx-04` | DGX H100: 8x H100 80GB, NVSwitch, 8x ConnectX-7 NDR 400G, `slurmd`, `kubelet`, DCGM |
+
+Simulated tools:
+
+- **GPU:** `nvidia-smi` (queries, `-q -d`, power, persistence, ECC, reset, MIG, topology, NVLink)
+- **Health:** `dcgmi`, `dmesg`, `journalctl`, `systemctl`, `ipmitool`
+- **Slurm:** `sinfo`, `squeue`, `scontrol`, `sbatch`, `srun`, `salloc` (with pyxis), `sacct`, `sacctmgr`, `sprio`, `sshare`
+- **Kubernetes:** `kubectl`, `helm` (GPU Operator, Network Operator), Run:ai CLI
+- **Containers:** `docker`, `enroot`, `ngc`, `nvidia-ctk`, `crictl`
+- **BCM:** `cmsh` (device, category, softwareimage, user, power, imageupdate, grabimage)
+- **Fabric and Magnum IO:** `ibstat`, `ibdiagnet`, `mlxlink`, `perfquery`, NCCL tests (`all_reduce_perf`, `mpirun`), GPUDirect RDMA/Storage checks
+- **DPU:** BlueField tools (`mlxconfig`, `bfb-install`, DOCA services)
+- **Shell basics:** `cd`, `pwd`, `ls`, `cat`, `grep`, `sed -i`, heredocs, pipes and redirects; `nano`, `vi` and `vim` open your real editor; `--help` and `man` work as on a real node
+
+`commands` inside a lab prints the full list.
+
+**Limits:** outputs are realistic but simplified, and only the options that matter for the exam are implemented. If something doesn't parse, try the canonical form of the command. If a real command behaves differently from the simulator, trust the real one, and please open an issue.
+
+## Licence
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+## Trust model
+
+Scenario files are **code**: `checks` are Python expressions and `setup` may contain Python, both run on your machine. They come only from this package and, if you use one, your own solutions directory. Commands you type in a lab never reach `eval`/`exec`; they are parsed by the simulated tools. Only install scenario files you trust.
+
+## Code layout
+
+```
+src/greenray/
+  cli.py            command-line entry point (argparse)
+  core/             cluster state model, bash-like shell, errors
+  commands/         one module per tool family (nvidia_smi, slurm, kubectl, cmsh, ib, ...)
+  content/          loaders: scenarios, questions, solutions, command guides, validation, domains
+  app/              interactive layer: lab runner, question drill, mock exam, progress, UI
+  data/scenarios/   scenario files (problem only)
+  data/questions/   question bank (questions only)
+  data/solutions/   reference solutions, answer keys and lab solutions
+  data/command_guides.yaml   scenario-agnostic guides for `explain`
+tests/              pytest suite, including a replay of every reference solution
+docs/               SCENARIO_FORMAT.md, COVERAGE.md
+```
+
+## Adding scenarios and questions
+
+- Scenarios: the problem goes in `src/greenray/data/scenarios/` and the solution in `src/greenray/data/solutions/scenarios/`. See [docs/SCENARIO_FORMAT.md](docs/SCENARIO_FORMAT.md). Add every new scenario to [docs/COVERAGE.md](docs/COVERAGE.md).
+- Questions: these go in `src/greenray/data/questions/`, with the answer key in `src/greenray/data/solutions/questions/<same file>`. The format is documented in `src/greenray/content/questions.py`.
+- Run `uv run greenray validate` and `uv run pytest` before committing. CI runs lint and tests on every push.
+
+All content is original and written from public documentation concepts. It is not copied from the exam.
+
+## Related
+
+- Real-hardware practice that complements the simulator: the RTX 4060 / WSL2 labs and the rented-GPU cloud session kit live in the companion study repository, NVIDIA-NCP-AIO-Prep (`labs/gpu-local`, `labs/cloud-gpu`).

greenray_aio-0.5.0/README.md

@@ -0,0 +1,187 @@
+# GreenRay AIO
+
+**Hands-on lab simulator and mock exam for the NVIDIA-Certified Professional: AI Operations (NCP-AIO) exam.**
+
+GreenRay AIO drops you into a broken or half-configured **4-node DGX H100 cluster managed by Base Command Manager (BCM)**. You investigate and fix it with the same commands you'd use on real systems:
+- `nvidia-smi` and `dcgmi`
+- Slurm
+- `kubectl` and `helm` with the GPU Operator
+- `cmsh`
+- InfiniBand tools and NCCL tests
+- Docker and NGC containers
+
+`check` grades the end state of the cluster, not whether you typed a particular command.
+
+- **39 incident and task scenarios** covering every topic of the exam blueprint ([docs/COVERAGE.md](docs/COVERAGE.md))
+- **Incident mode**: only the incident report is shown, and the root cause stays hidden until the debrief
+- **`explain <command>`** for learning tools as you need them, plus progressive hints and a debrief after every lab
+- **Feels like a real node**: `--help` and `man` pages, `nano`/`vim` (your real editor), `cd` with tab completion of paths, command history, `watch`, live `dmon` samples, a coloured prompt and real-tool colours
+- **Full mock exam** in the current format: 30 questions plus 3 hands-on labs in 120 minutes (per NVIDIA's exam page; re-check before booking)
+- Runs anywhere Python runs: Linux, WSL, macOS or Windows. **No GPU needed.**
+
+```
+root@bcm-head:~# ssh dgx-03
+root@dgx-03:~# dmesg | grep -i xid
+[ 8812.402113] NVRM: Xid (PCI:0000:5d:00): 79, pid=0, GPU has fallen off the bus.
+root@dgx-03:~# nvidia-smi
+Unable to determine the device handle for GPU00000000:5D:00.0: Unknown Error
+...
+root@dgx-03:~# check
+  PASS  you read the kernel log on dgx-03
+  ....  2 more success criteria not met yet
+```
+
+> GreenRay AIO is an independent study tool. It is **not affiliated with, endorsed by or sponsored by NVIDIA**. NVIDIA, DGX, NCP-AIO and related names are trademarks of NVIDIA Corporation, used here only to describe the exam this tool helps you prepare for. Every node, GPU and log is simulated.
+
+## Install
+
+Pick one. A GPU is **not** required.
+
+**With uv or pipx** (any OS with Python 3.10+):
+
+```bash
+uv tool install greenray-aio      # or: pipx install greenray-aio
+greenray
+```
+
+**With Docker** (nothing to install):
+
+```bash
+docker run -it --rm -v greenray:/home/lab/.greenray ghcr.io/rehmanayounis/greenray-aio
+```
+
+The named volume keeps your progress between runs.
+
+**From source** (to contribute):
+
+```bash
+git clone https://github.com/RehmanaYounis/greenray-aio.git
+cd greenray-aio && uv sync && uv run greenray
+```
+
+Use WSL rather than PowerShell on Windows for the best terminal experience. `greenray doctor` prints your environment when something looks wrong.
+
+Developer commands (see [CONTRIBUTING.md](CONTRIBUTING.md)):
+
+```bash
+uv run pytest            # test suite (add --cov for coverage)
+uv run ruff check .      # lint
+uv run ruff format .     # format
+uv run mypy              # type checks
+uv build                 # wheel + sdist
+docker build -t greenray-aio .
+```
+
+## Use
+
+Installed with uv tool, pipx or Docker, the command is `greenray …`. From a source checkout use `uv run greenray …`.
+
+| Command | What it does |
+| --- | --- |
+| `greenray` | Interactive menu (`--no-color` for plain output) |
+| `greenray list` | All scenarios by exam domain, with your pass marks |
+| `greenray incident [-d DOMAIN] [-t TOPIC]` | **Investigate a random incident.** Only the incident report is shown; the scenario's id, title and success criteria stay hidden until the debrief. `-t` takes a scenario tag such as `slurm`, `kubernetes`, `bcm`, `mig` or `infiniband` |
+| `greenray incident --id <id>` | Retry a specific scenario as an incident (for a fresh independent attempt) |
+| `greenray lab <id>` | Start a hands-on scenario in guided mode (title, objectives and hints visible) |
+| `greenray sandbox` | A healthy cluster to explore freely |
+| `greenray mock` | **Full mock exam:** 30 questions + 3 labs (one Slurm, one Kubernetes, one BCM) in 120 minutes, with no hints. Graded at the end |
+| `greenray exam` | Question drill: 60 questions in 120 minutes, weighted 31/23/23/23 like the blueprint |
+| `greenray exam -n 20 -m 40 -d "Administration"` | Domain drill |
+| `greenray progress` | Passed labs, exam history, weakest domain |
+| `greenray validate` | Self-test: every scenario is solvable by its reference solution |
+| `greenray doctor` | Version, Python, terminal, editor, solutions source and progress path |
+
+Inside a lab, these meta-commands are available alongside the simulated cluster commands:
+
+| Command | What it does |
+| --- | --- |
+| `task` | Show the briefing again |
+| `check` | Grade your work. In incident mode, unmet criteria are counted but not named |
+| `explain <cmd>` | What a command is for, its useful options, what to look for in its output, and common errors. It never describes a scenario's fix |
+| `hint` | Show the next hint. Hints get more specific, and the last one asks for confirmation because it is close to the answer |
+| `objectives` | Incident mode only: reveal the success criteria (this attempt then counts as guided) |
+| `retry` | Incident mode only: start a fresh attempt (cluster, timer, hints and objectives reset) |
+| `solution` | Give up and see the answer, explanation and edge cases |
+| `reset` | Put the cluster back to the broken state. Same attempt: hints used and the timer carry over |
+| `commands` | List the simulated tools |
+| `quit` | Leave the lab |
+
+When you pass, you get the **debrief**: the reference solution, why it works, the edge cases and exam traps, **your own commands** for comparison, and a related scenario to practise next. Read it even when you passed. Ctrl-C cancels the current line, as in bash.
+
+### Guided or independent
+
+`greenray progress` shows three counts per domain:
+- **passed**
+- **without hints**
+- **as an incident, unguided**: passed in incident mode with no hints and no revealed objectives
+
+A good routine is to learn a topic in guided mode first, then prove it with `greenray incident -t <topic>`.
+
+### What the grader can and cannot judge
+
+- It grades the **end state** of the cluster, so any valid fix passes. For example, `nvidia-smi -pm 1` and `systemctl enable --now nvidia-persistenced` are both accepted for persistence mode.
+- Evidence checks confirm that you **ran** the diagnostic commands. Except where a check says otherwise, they do **not** check that you ran them before changing anything. Diagnose first anyway; the debrief reminds you.
+- It does not generally detect unnecessary changes. Only some scenarios guard against specific harmful ones, such as raising power limits to hide a thermal fault, or killing a user's job.
+- If a command ever crashes inside the simulator (a bug), the cluster is restored to its state before that command and you are told so.
+
+Progress is stored in `~/.greenray/progress.json` on your machine (set `GREENRAY_HOME` to move it). Progress from the older `~/.aiolab` folder is copied over automatically the first time you run it.
+
+## The simulated cluster
+
+| Host | Role |
+| --- | --- |
+| `bcm-head` | BCM head node (`cmsh`), Slurm controller, Kubernetes control plane, NGC CLI |
+| `dgx-01` … `dgx-04` | DGX H100: 8x H100 80GB, NVSwitch, 8x ConnectX-7 NDR 400G, `slurmd`, `kubelet`, DCGM |
+
+Simulated tools:
+
+- **GPU:** `nvidia-smi` (queries, `-q -d`, power, persistence, ECC, reset, MIG, topology, NVLink)
+- **Health:** `dcgmi`, `dmesg`, `journalctl`, `systemctl`, `ipmitool`
+- **Slurm:** `sinfo`, `squeue`, `scontrol`, `sbatch`, `srun`, `salloc` (with pyxis), `sacct`, `sacctmgr`, `sprio`, `sshare`
+- **Kubernetes:** `kubectl`, `helm` (GPU Operator, Network Operator), Run:ai CLI
+- **Containers:** `docker`, `enroot`, `ngc`, `nvidia-ctk`, `crictl`
+- **BCM:** `cmsh` (device, category, softwareimage, user, power, imageupdate, grabimage)
+- **Fabric and Magnum IO:** `ibstat`, `ibdiagnet`, `mlxlink`, `perfquery`, NCCL tests (`all_reduce_perf`, `mpirun`), GPUDirect RDMA/Storage checks
+- **DPU:** BlueField tools (`mlxconfig`, `bfb-install`, DOCA services)
+- **Shell basics:** `cd`, `pwd`, `ls`, `cat`, `grep`, `sed -i`, heredocs, pipes and redirects; `nano`, `vi` and `vim` open your real editor; `--help` and `man` work as on a real node
+
+`commands` inside a lab prints the full list.
+
+**Limits:** outputs are realistic but simplified, and only the options that matter for the exam are implemented. If something doesn't parse, try the canonical form of the command. If a real command behaves differently from the simulator, trust the real one, and please open an issue.
+
+## Licence
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+## Trust model
+
+Scenario files are **code**: `checks` are Python expressions and `setup` may contain Python, both run on your machine. They come only from this package and, if you use one, your own solutions directory. Commands you type in a lab never reach `eval`/`exec`; they are parsed by the simulated tools. Only install scenario files you trust.
+
+## Code layout
+
+```
+src/greenray/
+  cli.py            command-line entry point (argparse)
+  core/             cluster state model, bash-like shell, errors
+  commands/         one module per tool family (nvidia_smi, slurm, kubectl, cmsh, ib, ...)
+  content/          loaders: scenarios, questions, solutions, command guides, validation, domains
+  app/              interactive layer: lab runner, question drill, mock exam, progress, UI
+  data/scenarios/   scenario files (problem only)
+  data/questions/   question bank (questions only)
+  data/solutions/   reference solutions, answer keys and lab solutions
+  data/command_guides.yaml   scenario-agnostic guides for `explain`
+tests/              pytest suite, including a replay of every reference solution
+docs/               SCENARIO_FORMAT.md, COVERAGE.md
+```
+
+## Adding scenarios and questions
+
+- Scenarios: the problem goes in `src/greenray/data/scenarios/` and the solution in `src/greenray/data/solutions/scenarios/`. See [docs/SCENARIO_FORMAT.md](docs/SCENARIO_FORMAT.md). Add every new scenario to [docs/COVERAGE.md](docs/COVERAGE.md).
+- Questions: these go in `src/greenray/data/questions/`, with the answer key in `src/greenray/data/solutions/questions/<same file>`. The format is documented in `src/greenray/content/questions.py`.
+- Run `uv run greenray validate` and `uv run pytest` before committing. CI runs lint and tests on every push.
+
+All content is original and written from public documentation concepts. It is not copied from the exam.
+
+## Related
+
+- Real-hardware practice that complements the simulator: the RTX 4060 / WSL2 labs and the rented-GPU cloud session kit live in the companion study repository, NVIDIA-NCP-AIO-Prep (`labs/gpu-local`, `labs/cloud-gpu`).