diff --git a/doc_changes/.buildinfo b/doc_changes/.buildinfo index fbd20a7..addf39a 100644 --- a/doc_changes/.buildinfo +++ b/doc_changes/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 7d21253d69af47e58d49689379084818 +config: 29a89a376790ba430544cc27a5207164 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/doc_changes/.doctrees/environment.pickle b/doc_changes/.doctrees/environment.pickle index 81191ed..452f48c 100644 Binary files a/doc_changes/.doctrees/environment.pickle and b/doc_changes/.doctrees/environment.pickle differ diff --git a/doc_changes/.doctrees/tutorial.doctree b/doc_changes/.doctrees/tutorial.doctree index 0844086..c175513 100644 Binary files a/doc_changes/.doctrees/tutorial.doctree and b/doc_changes/.doctrees/tutorial.doctree differ diff --git a/doc_changes/_downloads/5bef59fe249d5283a14772fe8c2e7605/tutorial2_position_capture-1.pdf b/doc_changes/_downloads/5bef59fe249d5283a14772fe8c2e7605/tutorial2_position_capture-1.pdf index 3eb381a..03ffaa3 100644 Binary files a/doc_changes/_downloads/5bef59fe249d5283a14772fe8c2e7605/tutorial2_position_capture-1.pdf and b/doc_changes/_downloads/5bef59fe249d5283a14772fe8c2e7605/tutorial2_position_capture-1.pdf differ diff --git a/doc_changes/_downloads/b1044b53fd298f2e9771da4a700c37f2/tutorial2_position_capture-2.pdf b/doc_changes/_downloads/b1044b53fd298f2e9771da4a700c37f2/tutorial2_position_capture-2.pdf index 650579c..1fb41a9 100644 Binary files a/doc_changes/_downloads/b1044b53fd298f2e9771da4a700c37f2/tutorial2_position_capture-2.pdf and b/doc_changes/_downloads/b1044b53fd298f2e9771da4a700c37f2/tutorial2_position_capture-2.pdf differ diff --git a/doc_changes/_sources/tutorial.rst.txt b/doc_changes/_sources/tutorial.rst.txt index 7f490fe..75e4f71 100644 --- a/doc_changes/_sources/tutorial.rst.txt +++ b/doc_changes/_sources/tutorial.rst.txt @@ -1,4 +1,5 @@ -# Tutorials +Tutorials +========== Tutorials for installation and typical usage. New users start here. diff --git a/doc_changes/_static/documentation_options.js b/doc_changes/_static/documentation_options.js index 1036eb5..cae5089 100644 --- a/doc_changes/_static/documentation_options.js +++ b/doc_changes/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '3.1.dev24+gb864197', + VERSION: '3.1.dev25+gb458039', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/doc_changes/developer/explanations/decisions.html b/doc_changes/developer/explanations/decisions.html index 975fa63..c907268 100644 --- a/doc_changes/developer/explanations/decisions.html +++ b/doc_changes/developer/explanations/decisions.html @@ -8,7 +8,7 @@ - Architectural Decision Records — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Architectural Decision Records — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/developer/explanations/decisions/0001-record-architecture-decisions.html b/doc_changes/developer/explanations/decisions/0001-record-architecture-decisions.html index 2f4d811..34f67dc 100644 --- a/doc_changes/developer/explanations/decisions/0001-record-architecture-decisions.html +++ b/doc_changes/developer/explanations/decisions/0001-record-architecture-decisions.html @@ -8,7 +8,7 @@ - 1. Record architecture decisions — PandABlocks.github.io 3.1.dev24+gb864197 documentation + 1. Record architecture decisions — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/developer/explanations/decisions/0002-switched-to-pip-skeleton.html b/doc_changes/developer/explanations/decisions/0002-switched-to-pip-skeleton.html index aa4a99d..713e86f 100644 --- a/doc_changes/developer/explanations/decisions/0002-switched-to-pip-skeleton.html +++ b/doc_changes/developer/explanations/decisions/0002-switched-to-pip-skeleton.html @@ -8,7 +8,7 @@ - 2. Adopt python3-pip-skeleton for project structure — PandABlocks.github.io 3.1.dev24+gb864197 documentation + 2. Adopt python3-pip-skeleton for project structure — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/developer/how-to/contribute.html b/doc_changes/developer/how-to/contribute.html index 9707e1b..39ed71b 100644 --- a/doc_changes/developer/how-to/contribute.html +++ b/doc_changes/developer/how-to/contribute.html @@ -8,7 +8,7 @@ - Contributing to the project — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Contributing to the project — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/developer/how-to/make-release.html b/doc_changes/developer/how-to/make-release.html index 7cd4ffb..f8daf51 100644 --- a/doc_changes/developer/how-to/make-release.html +++ b/doc_changes/developer/how-to/make-release.html @@ -8,7 +8,7 @@ - Make a release — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Make a release — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/developer/how-to/run-container.html b/doc_changes/developer/how-to/run-container.html index 13c0e41..424d221 100644 --- a/doc_changes/developer/how-to/run-container.html +++ b/doc_changes/developer/how-to/run-container.html @@ -8,7 +8,7 @@ - Run in a container — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Run in a container — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/developer/how-to/update-tools.html b/doc_changes/developer/how-to/update-tools.html index d96df15..886895b 100644 --- a/doc_changes/developer/how-to/update-tools.html +++ b/doc_changes/developer/how-to/update-tools.html @@ -8,7 +8,7 @@ - Update the tools — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Update the tools — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/developer/index.html b/doc_changes/developer/index.html index 0ebfb97..e734664 100644 --- a/doc_changes/developer/index.html +++ b/doc_changes/developer/index.html @@ -8,7 +8,7 @@ - Developer Guide — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Developer Guide — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -150,7 +150,7 @@
  • - + Tutorials
    • @@ -382,7 +382,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/developer/reference/standards.html b/doc_changes/developer/reference/standards.html index 743ab14..8b898f3 100644 --- a/doc_changes/developer/reference/standards.html +++ b/doc_changes/developer/reference/standards.html @@ -8,7 +8,7 @@ - Standards — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Standards — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/genindex.html b/doc_changes/genindex.html index 884864d..6cdec3c 100644 --- a/doc_changes/genindex.html +++ b/doc_changes/genindex.html @@ -7,7 +7,7 @@ - Index — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Index — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -38,7 +38,7 @@ - + @@ -148,7 +148,7 @@
  • - + Tutorials
    • @@ -376,7 +376,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/index.html b/doc_changes/index.html index 59ca6ad..f02f6f4 100644 --- a/doc_changes/index.html +++ b/doc_changes/index.html @@ -8,7 +8,7 @@ - PandABlocks.github.io — PandABlocks.github.io 3.1.dev24+gb864197 documentation + PandABlocks.github.io — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -55,7 +55,7 @@ - + @@ -150,7 +150,7 @@
  • - + Tutorials
    • @@ -380,7 +380,7 @@
  • - + Tutorials
    • @@ -607,22 +607,13 @@

    How the documentation is structured
    @@ -731,7 +722,7 @@

    How the documentation is structured

    next

    -

    <no title>

    +

    Tutorials

     diff --git a/doc_changes/objects.inv b/doc_changes/objects.inv index 2b38471..0d8cb7e 100644 Binary files a/doc_changes/objects.inv and b/doc_changes/objects.inv differ diff --git a/doc_changes/plot_directive/user/tutorials/tutorial2_position_capture-1.pdf b/doc_changes/plot_directive/user/tutorials/tutorial2_position_capture-1.pdf index 3eb381a..03ffaa3 100644 Binary files a/doc_changes/plot_directive/user/tutorials/tutorial2_position_capture-1.pdf and b/doc_changes/plot_directive/user/tutorials/tutorial2_position_capture-1.pdf differ diff --git a/doc_changes/plot_directive/user/tutorials/tutorial2_position_capture-2.pdf b/doc_changes/plot_directive/user/tutorials/tutorial2_position_capture-2.pdf index 650579c..1fb41a9 100644 Binary files a/doc_changes/plot_directive/user/tutorials/tutorial2_position_capture-2.pdf and b/doc_changes/plot_directive/user/tutorials/tutorial2_position_capture-2.pdf differ diff --git a/doc_changes/search.html b/doc_changes/search.html index a37ff9f..c976dda 100644 --- a/doc_changes/search.html +++ b/doc_changes/search.html @@ -6,7 +6,7 @@ - Search - PandABlocks.github.io 3.1.dev24+gb864197 documentation + Search - PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -37,7 +37,7 @@ - + @@ -150,7 +150,7 @@
  • - + Tutorials
    • @@ -380,7 +380,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/searchindex.js b/doc_changes/searchindex.js index 69649bc..8dfa644 100644 --- a/doc_changes/searchindex.js +++ b/doc_changes/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["developer/explanations/decisions", "developer/explanations/decisions/0001-record-architecture-decisions", "developer/explanations/decisions/0002-switched-to-pip-skeleton", "developer/how-to/contribute", "developer/how-to/make-release", "developer/how-to/run-container", "developer/how-to/update-tools", "developer/index", "developer/reference/standards", "genindex", "index", "tutorial", "user/how-to/remote", "user/index", "user/reference/migration_guide", "user/reference/release_compatibility", "user/tutorials/tutorial1_blinking_leds", "user/tutorials/tutorial2_position_capture", "user/tutorials/tutorial3_position_compare", "user/tutorials/tutorial4_snake_scan"], "filenames": ["developer/explanations/decisions.rst", "developer/explanations/decisions/0001-record-architecture-decisions.rst", "developer/explanations/decisions/0002-switched-to-pip-skeleton.rst", "developer/how-to/contribute.rst", "developer/how-to/make-release.rst", "developer/how-to/run-container.rst", "developer/how-to/update-tools.rst", "developer/index.rst", "developer/reference/standards.rst", "genindex.rst", "index.rst", "tutorial.rst", "user/how-to/remote.rst", "user/index.rst", "user/reference/migration_guide.rst", "user/reference/release_compatibility.rst", "user/tutorials/tutorial1_blinking_leds.rst", "user/tutorials/tutorial2_position_capture.rst", "user/tutorials/tutorial3_position_compare.rst", "user/tutorials/tutorial4_snake_scan.rst"], "titles": ["Architectural Decision Records", "1. Record architecture decisions", "2. Adopt python3-pip-skeleton for project structure", "Contributing to the project", "Make a release", "Run in a container", "Update the tools", "Developer Guide", "Standards", "API Index", "PandABlocks.github.io", "<no title>", "Updating a PandA via SSH", "User Guide", "Migration Guide", "Release Compatibility table", "Blinking LEDs Tutorial", "Position Capture Tutorial", "Position Compare Tutorial", "Snake Scan Tutorial"], "terms": {"we": [0, 1, 2, 3, 16, 17], "major": [0, 12], "adr": [0, 1], "describ": [0, 1, 5], "michael": [0, 1], "nygard": [0, 1], "below": [0, 12, 15], "i": [0, 3, 5, 6, 7, 12, 13, 14, 16, 17, 19], "list": [0, 16], "our": [0, 17], "current": [0, 6, 16], "1": [0, 12, 15, 16, 17], "2": [0, 10, 13, 15, 17], "adopt": 0, "python3": [0, 6], "pip": [0, 6], "skeleton": [0, 6], "project": [0, 1, 6, 7, 10], "structur": [0, 6], "date": [1, 2], "2022": [1, 2], "02": [1, 2], "18": [1, 2, 17], "accept": [1, 2], "need": [1, 5, 12, 17], "made": 1, "thi": [1, 2, 4, 6, 8, 12, 16, 17, 18, 19], "us": [1, 2, 5, 7, 8, 12, 16, 17, 19], "see": [1, 4, 16, 17], "": [1, 17], "articl": 1, "link": [1, 7, 13, 16], "abov": [1, 5, 12, 17], "To": [1, 4, 5, 6, 12, 14], "creat": [1, 4, 5, 16, 18], "new": [1, 3, 4, 10, 11, 12, 13, 14], "copi": [1, 12], "past": 1, "from": [1, 2, 5, 7, 12, 13, 14, 16, 17], "exist": [1, 3, 10, 12], "ones": 1, "should": [2, 3, 12, 16, 17], "follow": [2, 3, 4, 5, 12, 14, 16, 17], "The": [2, 3, 5, 10, 12, 14, 17], "ensur": 2, "consist": [2, 12], "develop": [2, 5, 10], "environ": [2, 3], "packag": 2, "manag": 2, "have": [2, 3, 12, 16, 17], "switch": 2, "modul": [2, 6, 12], "fix": [2, 12], "set": [2, 3, 16, 17], "tool": [2, 7, 10], "can": [2, 10, 12, 16, 17], "pull": [2, 3, 5, 6], "updat": [2, 7, 10, 13, 14, 17], "latest": [2, 5, 6, 12], "techniqu": [2, 6], "As": 2, "mai": 2, "chang": [2, 3, 6, 14, 16, 17], "could": [2, 17], "differ": [2, 16, 17], "lint": 2, "format": [2, 17], "venv": 2, "setup": [2, 6], "ci": 2, "cd": 2, "issu": 3, "ar": [3, 12, 15, 16, 17], "most": 3, "welcom": [3, 16], "all": [3, 5, 16, 17], "request": [3, 6], "handl": 3, "through": [3, 16, 17], "github": [3, 4, 5, 6, 12], "also": [3, 7, 13, 16, 17], "pleas": [3, 4, 15], "check": [3, 6, 17], "ani": [3, 6, 12], "befor": 3, "file": [3, 12], "one": [3, 12, 14, 16, 17, 18], "If": [3, 12, 16, 17], "you": [3, 4, 5, 12, 16, 17, 18], "great": 3, "idea": 3, "involv": 3, "big": 3, "ticket": 3, "make": [3, 7, 10, 12, 16, 17], "want": [3, 17], "sure": [3, 12], "don": [3, 17], "t": [3, 17], "spend": 3, "your": [3, 5, 16], "time": [3, 17, 18], "someth": [3, 6], "might": 3, "fit": 3, "scope": 3, "while": [3, 12, 17], "100": 3, "doe": [3, 17], "librari": [3, 13], "bug": [3, 12], "free": 3, "significantli": 3, "reduc": 3, "number": [3, 4, 5, 12], "easili": 3, "caught": 3, "remain": 3, "same": [3, 4, 16, 17], "improv": 3, "contain": [3, 7, 10, 12], "inform": [3, 14, 16, 18], "up": [3, 7, 16], "run": [3, 6, 7, 10, 12], "test": 3, "what": [3, 17], "standard": [3, 7, 10], "document": [3, 7, 8, 13, 17], "checklist": 4, "choos": 4, "pep440": 4, "compliant": 4, "http": [4, 6, 10], "pep": 4, "python": [4, 6], "org": 4, "0440": 4, "go": [4, 17], "page": [4, 12, 16], "draft": 4, "click": [4, 16, 17], "tag": 4, "suppli": 4, "chose": 4, "gener": [4, 6, 17], "note": [4, 10, 13], "review": 4, "edit": [4, 5], "titl": 4, "publish": 4, "push": 4, "main": 4, "branch": 4, "ha": [4, 6, 12, 16, 17], "effect": 4, "except": 4, "get": [4, 5, 7, 17], "option": [4, 17], "A": [5, 12], "panda": [5, 10, 13, 14, 15, 16, 17], "avail": [5, 12], "reistri": 5, "registri": 5, "docker": 5, "ghcr": 5, "io": 5, "pandablock": [5, 12, 14, 16, 17], "dev": [5, 7, 10], "releas": [5, 7, 10, 12, 13], "version": [5, 6, 12, 14, 15], "instead": [5, 17], "three": 5, "directori": 5, "repo_dir": 5, "repositori": [5, 8], "vivado_dir": 5, "vivado": 5, "instal": [5, 10, 11, 12, 13], "build_dir": 5, "an": [5, 6, 12, 16, 17, 18], "empti": 5, "mount": 5, "volum": 5, "command": [5, 12], "rm": [5, 12], "v": 5, "repo": [5, 10], "z": 5, "build": [5, 10, 12], "scratch": 5, "xilinx": 5, "bin": [5, 12], "bash": 5, "path": [5, 12, 17], "which": [5, 6, 12, 15, 17], "occur": 5, "In": [5, 16, 17], "each": [5, 16, 17], "cp": 5, "config": 5, "exampl": [5, 17], "For": [5, 12, 16, 17], "match": [5, 12, 17], "local": 5, "system": [5, 12, 14, 16], "e": 5, "locat": 5, "fpga": [5, 10, 12, 14, 17], "appropri": [5, 12], "merg": [6, 16], "provid": [6, 17], "mean": [6, 12, 16, 17], "keep": [6, 16], "sync": [6, 12], "between": [6, 17], "multipl": 6, "git": 6, "rebas": 6, "fals": 6, "com": 6, "diamondlightsourc": 6, "conflict": 6, "indic": 6, "area": 6, "where": [6, 19], "close": 6, "more": [6, 13, 16], "detail": [6, 12, 17], "split": [7, 10, 13], "four": [7, 13], "categori": [7, 13], "access": [7, 12, 13], "side": [7, 13], "bar": [7, 13], "tutori": [7, 10, 11], "contribut": [7, 10], "practic": [7, 10, 13], "step": [7, 10, 12, 13, 14, 19], "dai": [7, 10], "task": [7, 10], "architectur": [7, 10], "decis": [7, 10], "record": [7, 10], "why": [7, 10, 13], "technic": [7, 10, 13], "materi": [7, 10, 13], "defin": 8, "organis": 10, "hold": 10, "firmwar": [10, 12, 14], "well": 10, "its": [10, 12, 16], "accompani": 10, "server": [10, 12, 14, 17], "rootf": [10, 14, 15], "pandabox": 10, "other": [10, 17], "devic": 10, "sourc": [10, 17], "code": [10, 17], "4": [10, 12, 16, 17], "section": [10, 16, 17], "blink": [10, 11, 13], "led": [10, 11, 13], "open": 10, "gui": 10, "load": [10, 12], "design": 10, "work": [10, 13], "bit": [10, 17], "bu": [10, 17], "conclus": 10, "posit": [10, 11, 13, 16, 19], "captur": [10, 11, 13, 16, 18], "compar": [10, 11, 13, 17, 19], "snake": [10, 11, 13], "scan": [10, 11, 13, 18], "typic": [10, 11, 13], "usag": [10, 11, 13], "user": [10, 11, 12], "start": [10, 11, 13, 17], "here": [10, 11, 13, 14, 17], "experienc": [10, 13], "migrat": [10, 13], "0": [10, 12, 13, 15, 17], "3": [10, 12, 13, 15, 17], "compat": [10, 13], "tabl": [10, 13, 17, 19], "index": [10, 13], "includ": [10, 13], "api": [10, 13, 14], "found": 10, "webcontrol": [10, 12], "client": [10, 17], "admin": [12, 16], "interfac": [12, 17], "quickstart_doc": 12, "sometim": 12, "necessari": 12, "onc": 12, "do": [12, 17, 19], "gain": 12, "over": [12, 16, 17, 19], "either": 12, "add": 12, "authorized_kei": 12, "sd": 12, "card": 12, "usb": 12, "It": [12, 16, 17, 18], "possibl": 12, "log": 12, "remot": 12, "perform": 12, "oper": 12, "onli": 12, "singl": [12, 16], "root": 12, "done": 12, "privileg": 12, "break": 12, "so": [12, 16, 17], "care": 12, "when": [12, 16, 17], "first": [12, 16, 17], "after": [12, 16, 17], "reboot": 12, "everyth": 12, "download": 12, "boot": 12, "x": [12, 19], "zip": 12, "unzip": 12, "somewher": 12, "md5sum": 12, "imagefil": 12, "cpio": 12, "gz": 12, "scp": 12, "my_panda_ip": 12, "two": [12, 17, 19], "md5": 12, "sum": [12, 17], "correctli": 12, "within": 12, "find": [12, 15], "scr": 12, "uimag": 12, "devicetre": 12, "dtb": 12, "uinitramf": 12, "v3": 12, "beyond": [12, 16], "now": [12, 16, 17], "come": 12, "combin": 12, "power": 12, "cycl": [12, 16], "box": [12, 16, 17], "zpg": 12, "slowfpga": 12, "onward": 12, "tmp": 12, "restart": 12, "servic": 12, "them": [12, 16, 17], "later": [12, 17], "were": 12, "subsequ": 12, "would": [12, 17], "fail": 12, "messag": 12, "lib": 12, "python2": 12, "7": [12, 17], "site": 12, "malcolm": 12, "web": [12, 16], "www": 12, "fpga_doc": 12, "alreadi": 12, "seen": [12, 17], "error": 12, "opt": 12, "retri": 12, "succe": 12, "still": [12, 16], "correct": 12, "requir": 12, "24vio": 12, "fmc": 12, "right": 12, "ipmi_definit": 12, "accord": 12, "product": 12, "revis": 12, "fmc24v": 12, "under": 12, "folder": 12, "write_eeprom": 12, "ipmi": 12, "definit": 12, "write": 12, "script": 12, "read": [12, 16, 17], "confirm": 12, "content": [12, 17], "via": [13, 14, 16], "ssh": [13, 14], "explan": 13, "wai": [13, 17], "kei": 14, "anoth": 14, "outlin": 14, "changelog": 14, "block": [14, 16, 17, 19], "calc": 14, "remov": 14, "field": [14, 16, 17], "func": 14, "clock": [14, 16, 17], "width": [14, 16], "widthunit": 14, "counter": [14, 17], "outmod": 14, "trigedg": 14, "inenc": 14, "encod": [14, 17, 18], "outenc": 14, "pcap": [14, 17], "sampl": [14, 17], "gatedur": 14, "seq": [14, 19], "health": 14, "canwritenext": 14, "sfp": 14, "dls_eventr": 14, "cplllock": 14, "panda_sync": 14, "err_cnt": 14, "bit9": 14, "bit10": 14, "bit11": 14, "bit12": 14, "bit13": 14, "bit14": 14, "bit15": 14, "bit16": 14, "ext_clock_freq": 14, "extclock": 14, "clocksourc": 14, "show": [15, 18], "togeth": [15, 16], "zpkg": 15, "introduc": [16, 17, 18, 19], "basic": 16, "wire": [16, 17], "flash": 16, "rate": 16, "point": [16, 17], "browser": 16, "ip": [16, 17], "address": 16, "hostnam": 16, "greet": 16, "At": 16, "bottom": 16, "doc": 16, "control": [16, 17], "entri": [16, 17], "dropdown": [16, 17], "allow": 16, "select": [16, 17], "save": 16, "store": 16, "item": 16, "method": 16, "wish": 16, "template_tutorial1_l": 16, "look": [16, 17], "front": 16, "panel": 16, "ttl": 16, "output": [16, 17], "turn": [16, 17], "sequenti": 16, "off": [16, 17], "opposit": 16, "order": 16, "50": 16, "duti": 16, "puls": [16, 17, 18], "train": [16, 17], "period": [16, 17], "pulse1": 16, "take": [16, 17], "input": [16, 17], "trigger": [16, 17, 18], "produc": [16, 17], "delai": [16, 17], "These": 16, "line": 16, "queu": 16, "seri": 16, "sent": 16, "out": [16, 17], "expir": 16, "increas": 16, "notic": 16, "continu": 16, "desir": 16, "howev": 16, "drop": 16, "report": 16, "avoid": 16, "try": 16, "modifi": [16, 17], "ttlout": 16, "palett": 16, "icon": 16, "drag": 16, "onto": 16, "canva": 16, "connect": [16, 17], "port": [16, 17], "val": 16, "visibl": 16, "blue": 16, "thei": 16, "repres": 16, "boolean": 16, "valu": [16, 17], "propag": 16, "view": [16, 17], "respect": 16, "left": 16, "hand": [16, 17], "pane": 16, "scroll": 16, "down": 16, "pattern": 16, "light": [16, 17], "poll": 16, "10hz": 16, "receiv": [16, 17], "whether": 16, "reflect": 16, "less": 16, "than": [16, 17], "5hz": 16, "displai": 16, "faster": [16, 17], "even": 16, "short": 16, "similar": 16, "behaviour": 16, "maximum": 16, "shown": [16, 17], "some": 16, "paramet": 16, "stretch": 16, "signal": [16, 17], "outsid": 16, "world": 16, "next": [16, 17], "about": [16, 17], "taken": 17, "visual": 17, "data": 17, "template_tutorial2_pcap": 17, "enabl": 17, "soon": 17, "becom": 17, "activ": 17, "gate": 17, "level": 17, "driven": 17, "window": 17, "edg": 17, "actual": 17, "trig_edg": 17, "fall": 17, "second": 17, "increment": 17, "both": 17, "half": 17, "best": 17, "diagram": 17, "png": 17, "hire": 17, "pdf": 17, "determin": 17, "instantan": 17, "choic": 17, "descript": 17, "No": 17, "diff": 17, "wa": 17, "high": 17, "min": 17, "smallest": 17, "max": 17, "largest": 17, "averag": 17, "There": 17, "like": 17, "frame": 17, "end": 17, "trig": 17, "tick": 17, "compens": 17, "length": 17, "align": 17, "counter1": 17, "being": 17, "correspond": 17, "rise": 17, "small": 17, "badg": 17, "press": 17, "submit": 17, "readi": 17, "ascii": 17, "binari": 17, "tcp": 17, "tango": 17, "epic": 17, "just": 17, "commandlin": 17, "nc": 17, "8889": 17, "specifi": 17, "header": 17, "ll": 17, "stick": 17, "default": 17, "return": 17, "again": 17, "ok": 17, "back": 17, "layout": 17, "arm": 17, "button": 17, "stream": 17, "termin": 17, "until": [17, 19], "disarm": 17, "miss": 17, "process": 17, "scale": 17, "doubl": 17, "offset": 17, "unit": 17, "talli": 17, "saw": 17, "went": 17, "5": 17, "clock2": 17, "8": 17, "13": 17, "plot": 17, "expect": 17, "mid": 17, "let": 17, "investig": 17, "6": 17, "hadn": 17, "put": 17, "rather": 17, "fed": 17, "v2f": 17, "total": 17, "count": 17, "given": 17, "11": 17, "16": 17, "dure": 17, "counter_valu": 17, "time_at_valu": 17, "gate_tim": 17, "give": 17, "detector": 17, "type": 17, "configur": 17, "concept": [18, 19], "dimension": [18, 19], "how": 18, "regularli": 18, "space": 18, "interv": 18, "base": 19, "dimens": 19, "forward": 19, "rang": 19, "y": 19, "backward": 19, "repeat": 19, "complet": 19}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"architectur": [0, 1], "decis": [0, 1, 2], "record": [0, 1], "1": 1, "statu": [1, 2], "context": [1, 2], "consequ": [1, 2], "2": [2, 14], "adopt": 2, "python3": 2, "pip": 2, "skeleton": 2, "project": [2, 3], "structur": [2, 10], "contribut": 3, "code": [3, 8], "coverag": 3, "develop": [3, 7], "guid": [3, 7, 10, 13, 14], "make": 4, "releas": [4, 15], "run": 5, "contain": 5, "start": 5, "updat": [6, 12], "tool": 6, "how": [7, 10, 13, 16, 17], "explan": [7, 10], "refer": [7, 10, 13], "standard": 8, "api": 9, "index": 9, "pandablock": 10, "github": 10, "io": 10, "document": 10, "i": 10, "panda": 12, "via": 12, "ssh": 12, "rootf": 12, "zpkg": 12, "packag": 12, "24v": 12, "eeprom": 12, "user": 13, "tutori": [13, 16, 17, 18, 19], "migrat": 14, "0": 14, "3": 14, "compat": 15, "tabl": 15, "blink": 16, "led": 16, "open": 16, "gui": 16, "load": [16, 17], "design": [16, 17], "work": [16, 17], "The": 16, "bit": 16, "bu": 16, "conclus": [16, 17], "posit": [17, 18], "captur": 17, "compar": 18, "snake": 19, "scan": 19}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Architectural Decision Records": [[0, "architectural-decision-records"]], "1. Record architecture decisions": [[1, "record-architecture-decisions"]], "Status": [[1, "status"], [2, "status"]], "Context": [[1, "context"], [2, "context"]], "Decision": [[1, "decision"], [2, "decision"]], "Consequences": [[1, "consequences"], [2, "consequences"]], "2. Adopt python3-pip-skeleton for project structure": [[2, "adopt-python3-pip-skeleton-for-project-structure"]], "Contributing to the project": [[3, "contributing-to-the-project"]], "Code coverage": [[3, "code-coverage"]], "Developer guide": [[3, "developer-guide"]], "Make a release": [[4, "make-a-release"]], "Run in a container": [[5, "run-in-a-container"]], "Starting the container": [[5, "starting-the-container"]], "Update the tools": [[6, "update-the-tools"]], "Developer Guide": [[7, "developer-guide"]], "How-to Guides": [[7, null], [10, null], [13, null]], "Explanations": [[7, null], [10, null]], "Reference": [[7, null], [10, null], [13, null]], "Standards": [[8, "standards"]], "Code Standards": [[8, "code-standards"]], "API Index": [[9, "api-index"]], "PandABlocks.github.io": [[10, "pandablocks-github-io"]], "How the documentation is structured": [[10, "how-the-documentation-is-structured"]], "Updating a PandA via SSH": [[12, "updating-a-panda-via-ssh"]], "Updating the rootfs": [[12, "updating-the-rootfs"]], "Updating zpkg packages": [[12, "updating-zpkg-packages"]], "Update 24V eeprom": [[12, "update-24v-eeprom"]], "User Guide": [[13, "user-guide"]], "Tutorials": [[13, null]], "Migration Guide": [[14, "migration-guide"]], "2.0 to 3.0": [[14, "to-3-0"]], "Release Compatibility table": [[15, "release-compatibility-table"]], "Blinking LEDs Tutorial": [[16, "blinking-leds-tutorial"]], "Opening the GUI": [[16, "opening-the-gui"]], "Loading the tutorial design": [[16, "loading-the-tutorial-design"], [17, "loading-the-tutorial-design"]], "How the design works": [[16, "how-the-design-works"], [17, "how-the-design-works"]], "The Bit Bus": [[16, "the-bit-bus"]], "Conclusion": [[16, "conclusion"], [17, "conclusion"]], "Position Capture Tutorial": [[17, "position-capture-tutorial"]], "Position Compare Tutorial": [[18, "position-compare-tutorial"]], "Snake Scan Tutorial": [[19, "snake-scan-tutorial"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["developer/explanations/decisions", "developer/explanations/decisions/0001-record-architecture-decisions", "developer/explanations/decisions/0002-switched-to-pip-skeleton", "developer/how-to/contribute", "developer/how-to/make-release", "developer/how-to/run-container", "developer/how-to/update-tools", "developer/index", "developer/reference/standards", "genindex", "index", "tutorial", "user/how-to/remote", "user/index", "user/reference/migration_guide", "user/reference/release_compatibility", "user/tutorials/tutorial1_blinking_leds", "user/tutorials/tutorial2_position_capture", "user/tutorials/tutorial3_position_compare", "user/tutorials/tutorial4_snake_scan"], "filenames": ["developer/explanations/decisions.rst", "developer/explanations/decisions/0001-record-architecture-decisions.rst", "developer/explanations/decisions/0002-switched-to-pip-skeleton.rst", "developer/how-to/contribute.rst", "developer/how-to/make-release.rst", "developer/how-to/run-container.rst", "developer/how-to/update-tools.rst", "developer/index.rst", "developer/reference/standards.rst", "genindex.rst", "index.rst", "tutorial.rst", "user/how-to/remote.rst", "user/index.rst", "user/reference/migration_guide.rst", "user/reference/release_compatibility.rst", "user/tutorials/tutorial1_blinking_leds.rst", "user/tutorials/tutorial2_position_capture.rst", "user/tutorials/tutorial3_position_compare.rst", "user/tutorials/tutorial4_snake_scan.rst"], "titles": ["Architectural Decision Records", "1. Record architecture decisions", "2. Adopt python3-pip-skeleton for project structure", "Contributing to the project", "Make a release", "Run in a container", "Update the tools", "Developer Guide", "Standards", "API Index", "PandABlocks.github.io", "Tutorials", "Updating a PandA via SSH", "User Guide", "Migration Guide", "Release Compatibility table", "Blinking LEDs Tutorial", "Position Capture Tutorial", "Position Compare Tutorial", "Snake Scan Tutorial"], "terms": {"we": [0, 1, 2, 3, 16, 17], "major": [0, 12], "adr": [0, 1], "describ": [0, 1, 5], "michael": [0, 1], "nygard": [0, 1], "below": [0, 12, 15], "i": [0, 3, 5, 6, 7, 12, 13, 14, 16, 17, 19], "list": [0, 16], "our": [0, 17], "current": [0, 6, 16], "1": [0, 12, 15, 16, 17], "2": [0, 10, 13, 15, 17], "adopt": 0, "python3": [0, 6], "pip": [0, 6], "skeleton": [0, 6], "project": [0, 1, 6, 7, 10], "structur": [0, 6], "date": [1, 2], "2022": [1, 2], "02": [1, 2], "18": [1, 2, 17], "accept": [1, 2], "need": [1, 5, 12, 17], "made": 1, "thi": [1, 2, 4, 6, 8, 12, 16, 17, 18, 19], "us": [1, 2, 5, 7, 8, 12, 16, 17, 19], "see": [1, 4, 16, 17], "": [1, 17], "articl": 1, "link": [1, 7, 13, 16], "abov": [1, 5, 12, 17], "To": [1, 4, 5, 6, 12, 14], "creat": [1, 4, 5, 16, 18], "new": [1, 3, 4, 10, 11, 12, 13, 14], "copi": [1, 12], "past": 1, "from": [1, 2, 5, 7, 12, 13, 14, 16, 17], "exist": [1, 3, 10, 12], "ones": 1, "should": [2, 3, 12, 16, 17], "follow": [2, 3, 4, 5, 12, 14, 16, 17], "The": [2, 3, 5, 10, 12, 14, 17], "ensur": 2, "consist": [2, 12], "develop": [2, 5, 10], "environ": [2, 3], "packag": 2, "manag": 2, "have": [2, 3, 12, 16, 17], "switch": 2, "modul": [2, 6, 12], "fix": [2, 12], "set": [2, 3, 16, 17], "tool": [2, 7, 10], "can": [2, 10, 12, 16, 17], "pull": [2, 3, 5, 6], "updat": [2, 7, 10, 13, 14, 17], "latest": [2, 5, 6, 12], "techniqu": [2, 6], "As": 2, "mai": 2, "chang": [2, 3, 6, 14, 16, 17], "could": [2, 17], "differ": [2, 16, 17], "lint": 2, "format": [2, 17], "venv": 2, "setup": [2, 6], "ci": 2, "cd": 2, "issu": 3, "ar": [3, 12, 15, 16, 17], "most": 3, "welcom": [3, 16], "all": [3, 5, 16, 17], "request": [3, 6], "handl": 3, "through": [3, 16, 17], "github": [3, 4, 5, 6, 12], "also": [3, 7, 13, 16, 17], "pleas": [3, 4, 15], "check": [3, 6, 17], "ani": [3, 6, 12], "befor": 3, "file": [3, 12], "one": [3, 12, 14, 16, 17, 18], "If": [3, 12, 16, 17], "you": [3, 4, 5, 12, 16, 17, 18], "great": 3, "idea": 3, "involv": 3, "big": 3, "ticket": 3, "make": [3, 7, 10, 12, 16, 17], "want": [3, 17], "sure": [3, 12], "don": [3, 17], "t": [3, 17], "spend": 3, "your": [3, 5, 16], "time": [3, 17, 18], "someth": [3, 6], "might": 3, "fit": 3, "scope": 3, "while": [3, 12, 17], "100": 3, "doe": [3, 17], "librari": [3, 13], "bug": [3, 12], "free": 3, "significantli": 3, "reduc": 3, "number": [3, 4, 5, 12], "easili": 3, "caught": 3, "remain": 3, "same": [3, 4, 16, 17], "improv": 3, "contain": [3, 7, 10, 12], "inform": [3, 14, 16, 18], "up": [3, 7, 16], "run": [3, 6, 7, 10, 12], "test": 3, "what": [3, 17], "standard": [3, 7, 10], "document": [3, 7, 8, 13, 17], "checklist": 4, "choos": 4, "pep440": 4, "compliant": 4, "http": [4, 6, 10], "pep": 4, "python": [4, 6], "org": 4, "0440": 4, "go": [4, 17], "page": [4, 12, 16], "draft": 4, "click": [4, 16, 17], "tag": 4, "suppli": 4, "chose": 4, "gener": [4, 6, 17], "note": [4, 10, 13], "review": 4, "edit": [4, 5], "titl": 4, "publish": 4, "push": 4, "main": 4, "branch": 4, "ha": [4, 6, 12, 16, 17], "effect": 4, "except": 4, "get": [4, 5, 7, 17], "option": [4, 17], "A": [5, 12], "panda": [5, 10, 13, 14, 15, 16, 17], "avail": [5, 12], "reistri": 5, "registri": 5, "docker": 5, "ghcr": 5, "io": 5, "pandablock": [5, 12, 14, 16, 17], "dev": [5, 7, 10], "releas": [5, 7, 10, 12, 13], "version": [5, 6, 12, 14, 15], "instead": [5, 17], "three": 5, "directori": 5, "repo_dir": 5, "repositori": [5, 8], "vivado_dir": 5, "vivado": 5, "instal": [5, 10, 11, 12, 13], "build_dir": 5, "an": [5, 6, 12, 16, 17, 18], "empti": 5, "mount": 5, "volum": 5, "command": [5, 12], "rm": [5, 12], "v": 5, "repo": [5, 10], "z": 5, "build": [5, 10, 12], "scratch": 5, "xilinx": 5, "bin": [5, 12], "bash": 5, "path": [5, 12, 17], "which": [5, 6, 12, 15, 17], "occur": 5, "In": [5, 16, 17], "each": [5, 16, 17], "cp": 5, "config": 5, "exampl": [5, 17], "For": [5, 12, 16, 17], "match": [5, 12, 17], "local": 5, "system": [5, 12, 14, 16], "e": 5, "locat": 5, "fpga": [5, 10, 12, 14, 17], "appropri": [5, 12], "merg": [6, 16], "provid": [6, 17], "mean": [6, 12, 16, 17], "keep": [6, 16], "sync": [6, 12], "between": [6, 17], "multipl": 6, "git": 6, "rebas": 6, "fals": 6, "com": 6, "diamondlightsourc": 6, "conflict": 6, "indic": 6, "area": 6, "where": [6, 19], "close": 6, "more": [6, 13, 16], "detail": [6, 12, 17], "split": [7, 10, 13], "four": [7, 13], "categori": [7, 13], "access": [7, 12, 13], "side": [7, 13], "bar": [7, 13], "tutori": [7, 10], "contribut": [7, 10], "practic": [7, 10, 13], "step": [7, 10, 12, 13, 14, 19], "dai": [7, 10], "task": [7, 10], "architectur": [7, 10], "decis": [7, 10], "record": [7, 10], "why": [7, 10, 13], "technic": [7, 10, 13], "materi": [7, 10, 13], "defin": 8, "organis": 10, "hold": 10, "firmwar": [10, 12, 14], "well": 10, "its": [10, 12, 16], "accompani": 10, "server": [10, 12, 14, 17], "rootf": [10, 14, 15], "pandabox": 10, "other": [10, 17], "devic": 10, "sourc": [10, 17], "code": [10, 17], "4": [10, 12, 16, 17], "section": [10, 16, 17], "blink": [10, 11, 13], "led": [10, 11, 13], "posit": [10, 11, 13, 16, 19], "captur": [10, 11, 13, 16, 18], "compar": [10, 11, 13, 17, 19], "snake": [10, 11, 13], "scan": [10, 11, 13, 18], "typic": [10, 11, 13], "usag": [10, 11, 13], "user": [10, 11, 12], "start": [10, 11, 13, 17], "here": [10, 11, 13, 14, 17], "experienc": [10, 13], "migrat": [10, 13], "0": [10, 12, 13, 15, 17], "3": [10, 12, 13, 15, 17], "compat": [10, 13], "tabl": [10, 13, 17, 19], "index": [10, 13], "includ": [10, 13], "api": [10, 13, 14], "found": 10, "webcontrol": [10, 12], "client": [10, 17], "admin": [12, 16], "interfac": [12, 17], "quickstart_doc": 12, "sometim": 12, "necessari": 12, "onc": 12, "do": [12, 17, 19], "gain": 12, "over": [12, 16, 17, 19], "either": 12, "add": 12, "authorized_kei": 12, "sd": 12, "card": 12, "load": 12, "usb": 12, "It": [12, 16, 17, 18], "possibl": 12, "log": 12, "remot": 12, "perform": 12, "oper": 12, "onli": 12, "singl": [12, 16], "root": 12, "done": 12, "privileg": 12, "break": 12, "so": [12, 16, 17], "care": 12, "when": [12, 16, 17], "first": [12, 16, 17], "after": [12, 16, 17], "reboot": 12, "everyth": 12, "download": 12, "boot": 12, "x": [12, 19], "zip": 12, "unzip": 12, "somewher": 12, "md5sum": 12, "imagefil": 12, "cpio": 12, "gz": 12, "scp": 12, "my_panda_ip": 12, "two": [12, 17, 19], "md5": 12, "sum": [12, 17], "correctli": 12, "within": 12, "find": [12, 15], "scr": 12, "uimag": 12, "devicetre": 12, "dtb": 12, "uinitramf": 12, "v3": 12, "beyond": [12, 16], "now": [12, 16, 17], "come": 12, "combin": 12, "power": 12, "cycl": [12, 16], "box": [12, 16, 17], "zpg": 12, "slowfpga": 12, "onward": 12, "tmp": 12, "restart": 12, "servic": 12, "them": [12, 16, 17], "later": [12, 17], "were": 12, "subsequ": 12, "would": [12, 17], "fail": 12, "messag": 12, "lib": 12, "python2": 12, "7": [12, 17], "site": 12, "malcolm": 12, "web": [12, 16], "www": 12, "fpga_doc": 12, "alreadi": 12, "seen": [12, 17], "error": 12, "opt": 12, "retri": 12, "succe": 12, "still": [12, 16], "correct": 12, "requir": 12, "24vio": 12, "fmc": 12, "right": 12, "ipmi_definit": 12, "accord": 12, "product": 12, "revis": 12, "fmc24v": 12, "under": 12, "folder": 12, "write_eeprom": 12, "ipmi": 12, "definit": 12, "write": 12, "script": 12, "read": [12, 16, 17], "confirm": 12, "content": [12, 17], "via": [13, 14, 16], "ssh": [13, 14], "explan": 13, "work": 13, "wai": [13, 17], "kei": 14, "anoth": 14, "outlin": 14, "changelog": 14, "block": [14, 16, 17, 19], "calc": 14, "remov": 14, "field": [14, 16, 17], "func": 14, "clock": [14, 16, 17], "width": [14, 16], "widthunit": 14, "counter": [14, 17], "outmod": 14, "trigedg": 14, "inenc": 14, "encod": [14, 17, 18], "outenc": 14, "pcap": [14, 17], "sampl": [14, 17], "gatedur": 14, "seq": [14, 19], "health": 14, "canwritenext": 14, "sfp": 14, "dls_eventr": 14, "cplllock": 14, "panda_sync": 14, "err_cnt": 14, "bit9": 14, "bit10": 14, "bit11": 14, "bit12": 14, "bit13": 14, "bit14": 14, "bit15": 14, "bit16": 14, "ext_clock_freq": 14, "extclock": 14, "clocksourc": 14, "show": [15, 18], "togeth": [15, 16], "zpkg": 15, "introduc": [16, 17, 18, 19], "basic": 16, "wire": [16, 17], "flash": 16, "rate": 16, "point": [16, 17], "browser": 16, "ip": [16, 17], "address": 16, "hostnam": 16, "greet": 16, "At": 16, "bottom": 16, "doc": 16, "control": [16, 17], "entri": [16, 17], "dropdown": [16, 17], "allow": 16, "select": [16, 17], "save": 16, "store": 16, "item": 16, "method": 16, "wish": 16, "template_tutorial1_l": 16, "look": [16, 17], "front": 16, "panel": 16, "ttl": 16, "output": [16, 17], "turn": [16, 17], "sequenti": 16, "off": [16, 17], "opposit": 16, "order": 16, "50": 16, "duti": 16, "puls": [16, 17, 18], "train": [16, 17], "period": [16, 17], "pulse1": 16, "take": [16, 17], "input": [16, 17], "trigger": [16, 17, 18], "produc": [16, 17], "delai": [16, 17], "These": 16, "line": 16, "queu": 16, "seri": 16, "sent": 16, "out": [16, 17], "expir": 16, "increas": 16, "notic": 16, "continu": 16, "desir": 16, "howev": 16, "drop": 16, "report": 16, "avoid": 16, "try": 16, "modifi": [16, 17], "ttlout": 16, "palett": 16, "icon": 16, "drag": 16, "onto": 16, "canva": 16, "connect": [16, 17], "port": [16, 17], "val": 16, "visibl": 16, "blue": 16, "thei": 16, "repres": 16, "boolean": 16, "valu": [16, 17], "propag": 16, "view": [16, 17], "respect": 16, "left": 16, "hand": [16, 17], "pane": 16, "scroll": 16, "down": 16, "pattern": 16, "light": [16, 17], "poll": 16, "10hz": 16, "receiv": [16, 17], "whether": 16, "reflect": 16, "less": 16, "than": [16, 17], "5hz": 16, "displai": 16, "faster": [16, 17], "even": 16, "short": 16, "similar": 16, "behaviour": 16, "maximum": 16, "shown": [16, 17], "some": 16, "paramet": 16, "stretch": 16, "signal": [16, 17], "outsid": 16, "world": 16, "next": [16, 17], "about": [16, 17], "taken": 17, "visual": 17, "data": 17, "template_tutorial2_pcap": 17, "enabl": 17, "soon": 17, "becom": 17, "activ": 17, "gate": 17, "level": 17, "driven": 17, "window": 17, "edg": 17, "actual": 17, "trig_edg": 17, "fall": 17, "second": 17, "increment": 17, "both": 17, "half": 17, "best": 17, "diagram": 17, "png": 17, "hire": 17, "pdf": 17, "determin": 17, "bit": 17, "instantan": 17, "choic": 17, "descript": 17, "No": 17, "diff": 17, "wa": 17, "high": 17, "min": 17, "smallest": 17, "max": 17, "largest": 17, "averag": 17, "There": 17, "like": 17, "frame": 17, "end": 17, "trig": 17, "tick": 17, "compens": 17, "length": 17, "align": 17, "counter1": 17, "being": 17, "correspond": 17, "rise": 17, "small": 17, "badg": 17, "press": 17, "submit": 17, "readi": 17, "ascii": 17, "binari": 17, "tcp": 17, "tango": 17, "epic": 17, "just": 17, "commandlin": 17, "nc": 17, "8889": 17, "specifi": 17, "header": 17, "ll": 17, "stick": 17, "default": 17, "return": 17, "again": 17, "ok": 17, "back": 17, "layout": 17, "arm": 17, "button": 17, "stream": 17, "termin": 17, "until": [17, 19], "disarm": 17, "miss": 17, "process": 17, "scale": 17, "doubl": 17, "offset": 17, "unit": 17, "talli": 17, "saw": 17, "went": 17, "5": 17, "clock2": 17, "8": 17, "13": 17, "plot": 17, "expect": 17, "mid": 17, "let": 17, "investig": 17, "6": 17, "hadn": 17, "put": 17, "rather": 17, "fed": 17, "v2f": 17, "total": 17, "count": 17, "given": 17, "11": 17, "16": 17, "dure": 17, "counter_valu": 17, "time_at_valu": 17, "gate_tim": 17, "give": 17, "detector": 17, "bu": 17, "type": 17, "configur": 17, "concept": [18, 19], "dimension": [18, 19], "how": 18, "regularli": 18, "space": 18, "interv": 18, "base": 19, "dimens": 19, "forward": 19, "rang": 19, "y": 19, "backward": 19, "repeat": 19, "complet": 19}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"architectur": [0, 1], "decis": [0, 1, 2], "record": [0, 1], "1": 1, "statu": [1, 2], "context": [1, 2], "consequ": [1, 2], "2": [2, 14], "adopt": 2, "python3": 2, "pip": 2, "skeleton": 2, "project": [2, 3], "structur": [2, 10], "contribut": 3, "code": [3, 8], "coverag": 3, "develop": [3, 7], "guid": [3, 7, 10, 13, 14], "make": 4, "releas": [4, 15], "run": 5, "contain": 5, "start": 5, "updat": [6, 12], "tool": 6, "how": [7, 10, 13, 16, 17], "explan": [7, 10], "refer": [7, 10, 13], "standard": 8, "api": 9, "index": 9, "pandablock": 10, "github": 10, "io": 10, "document": 10, "i": 10, "tutori": [11, 13, 16, 17, 18, 19], "panda": 12, "via": 12, "ssh": 12, "rootf": 12, "zpkg": 12, "packag": 12, "24v": 12, "eeprom": 12, "user": 13, "migrat": 14, "0": 14, "3": 14, "compat": 15, "tabl": 15, "blink": 16, "led": 16, "open": 16, "gui": 16, "load": [16, 17], "design": [16, 17], "work": [16, 17], "The": 16, "bit": 16, "bu": 16, "conclus": [16, 17], "posit": [17, 18], "captur": 17, "compar": 18, "snake": 19, "scan": 19}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Architectural Decision Records": [[0, "architectural-decision-records"]], "1. Record architecture decisions": [[1, "record-architecture-decisions"]], "Status": [[1, "status"], [2, "status"]], "Context": [[1, "context"], [2, "context"]], "Decision": [[1, "decision"], [2, "decision"]], "Consequences": [[1, "consequences"], [2, "consequences"]], "2. Adopt python3-pip-skeleton for project structure": [[2, "adopt-python3-pip-skeleton-for-project-structure"]], "Contributing to the project": [[3, "contributing-to-the-project"]], "Code coverage": [[3, "code-coverage"]], "Developer guide": [[3, "developer-guide"]], "Make a release": [[4, "make-a-release"]], "Run in a container": [[5, "run-in-a-container"]], "Starting the container": [[5, "starting-the-container"]], "Update the tools": [[6, "update-the-tools"]], "Developer Guide": [[7, "developer-guide"]], "How-to Guides": [[7, null], [10, null], [13, null]], "Explanations": [[7, null], [10, null]], "Reference": [[7, null], [10, null], [13, null]], "Standards": [[8, "standards"]], "Code Standards": [[8, "code-standards"]], "API Index": [[9, "api-index"]], "PandABlocks.github.io": [[10, "pandablocks-github-io"]], "How the documentation is structured": [[10, "how-the-documentation-is-structured"]], "Tutorials": [[11, "tutorials"], [13, null]], "Updating a PandA via SSH": [[12, "updating-a-panda-via-ssh"]], "Updating the rootfs": [[12, "updating-the-rootfs"]], "Updating zpkg packages": [[12, "updating-zpkg-packages"]], "Update 24V eeprom": [[12, "update-24v-eeprom"]], "User Guide": [[13, "user-guide"]], "Migration Guide": [[14, "migration-guide"]], "2.0 to 3.0": [[14, "to-3-0"]], "Release Compatibility table": [[15, "release-compatibility-table"]], "Blinking LEDs Tutorial": [[16, "blinking-leds-tutorial"]], "Opening the GUI": [[16, "opening-the-gui"]], "Loading the tutorial design": [[16, "loading-the-tutorial-design"], [17, "loading-the-tutorial-design"]], "How the design works": [[16, "how-the-design-works"], [17, "how-the-design-works"]], "The Bit Bus": [[16, "the-bit-bus"]], "Conclusion": [[16, "conclusion"], [17, "conclusion"]], "Position Capture Tutorial": [[17, "position-capture-tutorial"]], "Position Compare Tutorial": [[18, "position-compare-tutorial"]], "Snake Scan Tutorial": [[19, "snake-scan-tutorial"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/doc_changes/tutorial.html b/doc_changes/tutorial.html index b66827f..bf3136e 100644 --- a/doc_changes/tutorial.html +++ b/doc_changes/tutorial.html @@ -8,7 +8,7 @@ - <no title> — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Tutorials — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • @@ -603,7 +603,7 @@ -
  • <no title>
    • +
  • Tutorials
    • @@ -620,7 +620,8 @@
    -

    # Tutorials

    +
    +

    Tutorials#

    Tutorials for installation and typical usage. New users start here.

    +
    diff --git a/doc_changes/user/how-to/remote.html b/doc_changes/user/how-to/remote.html index 9d746af..a5028e2 100644 --- a/doc_changes/user/how-to/remote.html +++ b/doc_changes/user/how-to/remote.html @@ -8,7 +8,7 @@ - Updating a PandA via SSH — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Updating a PandA via SSH — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/user/index.html b/doc_changes/user/index.html index dc760f7..462d495 100644 --- a/doc_changes/user/index.html +++ b/doc_changes/user/index.html @@ -8,7 +8,7 @@ - User Guide — PandABlocks.github.io 3.1.dev24+gb864197 documentation + User Guide — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/user/reference/migration_guide.html b/doc_changes/user/reference/migration_guide.html index 75b7d9a..5c59b10 100644 --- a/doc_changes/user/reference/migration_guide.html +++ b/doc_changes/user/reference/migration_guide.html @@ -8,7 +8,7 @@ - Migration Guide — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Migration Guide — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/user/reference/release_compatibility.html b/doc_changes/user/reference/release_compatibility.html index 411c2b1..ba6fea5 100644 --- a/doc_changes/user/reference/release_compatibility.html +++ b/doc_changes/user/reference/release_compatibility.html @@ -8,7 +8,7 @@ - Release Compatibility table — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Release Compatibility table — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • diff --git a/doc_changes/user/tutorials/tutorial1_blinking_leds.html b/doc_changes/user/tutorials/tutorial1_blinking_leds.html index 170bd46..e9d0bd6 100644 --- a/doc_changes/user/tutorials/tutorial1_blinking_leds.html +++ b/doc_changes/user/tutorials/tutorial1_blinking_leds.html @@ -8,7 +8,7 @@ - Blinking LEDs Tutorial — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Blinking LEDs Tutorial — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -56,7 +56,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • @@ -616,7 +616,7 @@ -
  • <no title>
    • +
  • Tutorials
  • Blinking...
    • @@ -724,7 +724,7 @@

    Conclusion

    previous

    -

    <no title>

    +

    Tutorials

     - Position Capture Tutorial — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Position Capture Tutorial — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • @@ -616,7 +616,7 @@ -
  • <no title>
    • +
  • Tutorials
  • Position...
    • diff --git a/doc_changes/user/tutorials/tutorial3_position_compare.html b/doc_changes/user/tutorials/tutorial3_position_compare.html index b676aa1..017bd29 100644 --- a/doc_changes/user/tutorials/tutorial3_position_compare.html +++ b/doc_changes/user/tutorials/tutorial3_position_compare.html @@ -8,7 +8,7 @@ - Position Compare Tutorial — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Position Compare Tutorial — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • @@ -616,7 +616,7 @@ -
  • <no title>
    • +
  • Tutorials
  • Position...
    • diff --git a/doc_changes/user/tutorials/tutorial4_snake_scan.html b/doc_changes/user/tutorials/tutorial4_snake_scan.html index 30f2ef0..a2c6243 100644 --- a/doc_changes/user/tutorials/tutorial4_snake_scan.html +++ b/doc_changes/user/tutorials/tutorial4_snake_scan.html @@ -8,7 +8,7 @@ - Snake Scan Tutorial — PandABlocks.github.io 3.1.dev24+gb864197 documentation + Snake Scan Tutorial — PandABlocks.github.io 3.1.dev25+gb458039 documentation @@ -39,7 +39,7 @@ - + @@ -151,7 +151,7 @@
  • - + Tutorials
    • @@ -383,7 +383,7 @@
  • - + Tutorials
    • @@ -616,7 +616,7 @@ -
  • <no title>
    • +
  • Tutorials
  • Snake Scan Tutorial