pypulseqpp 0.0.67
Basename is uppercase README.mdCalls glob for filename search
SHA-256d655a9466ba08183486418b8bef3b05c72382c99ad97481423c653e613858616
Evidence
1---
2name: add-a-sequence
3description: Add a complete sequence to examples/sequence/, or change one that is already shipped. Use when a new sequence function has to be written, or a shipped one changed, classified in the catalogue, given a gallery page and covered by tests, so that the documentation build and the docs tests stay consistent.
4---
5
6# Ad …
9:41… e touches five places; the docs tests
10fail if any is left out.
11
12## 1. The sequence module
13
14A new sequence is a function `sequence(system, **protocol)` that returns a
15`Sequence`, or a list of sequences with the prescans first and the main
16sequence last. The module sets `main = <function>` at module le …
22:6… tion, and `sequences.parameters` reads the same for protocol editors. Every
23 parameter with a default records it as ``default=<repr>``, and the do …
9:16… anything imports `pypulseqpp`. Run the whole sequence and
10report the results it actually produced.
11
12```bash
13git submodule update --init --recursive
14pip install -e '.[dev]' -r tests/requirements.txt
15bash scripts/format_and_lint.sh --check
16pytest -q
17```
18
19`scripts/format_and_lint.sh` runs `ruff format` and `ruff check`; withou …
120:6… build and inspect the result, including the sidebar hierarchy:
121
122```bash
123bash scripts/build_docs.sh # docs/build/html/index.html
124bash scripts/build_docs_pdf.sh # docs/build/pypulseqpp-do …
Showing the top 5 files — 6 more files (86 regions) not shown.
No evidence locations were recorded for this file. Raw result