diff --git a/main/.buildinfo b/main/.buildinfo index fd69c397..13da036e 100644 --- a/main/.buildinfo +++ b/main/.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: b130912eb89539a806ea6465e1708c1b +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 0d862c2ea69f6ba1cf4e8d615f78d906 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/reference/rest_api.doctree b/main/.doctrees/reference/rest_api.doctree index a2f18e79..e89e138f 100644 Binary files a/main/.doctrees/reference/rest_api.doctree and b/main/.doctrees/reference/rest_api.doctree differ diff --git a/main/_api.html b/main/_api.html index de119569..7da05d35 100644 --- a/main/_api.html +++ b/main/_api.html @@ -8,7 +8,7 @@ - API — scanspec 0.7.4.dev1+g4deecf8b documentation + API — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/_api/scanspec.core.html b/main/_api/scanspec.core.html index 934c46a3..773d42da 100644 --- a/main/_api/scanspec.core.html +++ b/main/_api/scanspec.core.html @@ -8,7 +8,7 @@ - scanspec.core — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec.core — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/_api/scanspec.html b/main/_api/scanspec.html index 8b712cac..5c31bd5a 100644 --- a/main/_api/scanspec.html +++ b/main/_api/scanspec.html @@ -8,7 +8,7 @@ - scanspec — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/_api/scanspec.plot.html b/main/_api/scanspec.plot.html index 90a5ca3b..1ce2ca27 100644 --- a/main/_api/scanspec.plot.html +++ b/main/_api/scanspec.plot.html @@ -8,7 +8,7 @@ - scanspec.plot — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec.plot — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/_api/scanspec.regions.html b/main/_api/scanspec.regions.html index 8a8a3b43..bff1dc66 100644 --- a/main/_api/scanspec.regions.html +++ b/main/_api/scanspec.regions.html @@ -8,7 +8,7 @@ - scanspec.regions — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec.regions — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/_api/scanspec.specs.html b/main/_api/scanspec.specs.html index 289b858a..6bd6281a 100644 --- a/main/_api/scanspec.specs.html +++ b/main/_api/scanspec.specs.html @@ -8,7 +8,7 @@ - scanspec.specs — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec.specs — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/_downloads/0ae73fb7939821b1edc3d22233280318/scanspec-regions-1.pdf b/main/_downloads/0ae73fb7939821b1edc3d22233280318/scanspec-regions-1.pdf index 95316ca0..69728191 100644 Binary files a/main/_downloads/0ae73fb7939821b1edc3d22233280318/scanspec-regions-1.pdf and b/main/_downloads/0ae73fb7939821b1edc3d22233280318/scanspec-regions-1.pdf differ diff --git a/main/_downloads/0b4799657e877d5b1b4cacd9b2acb170/why-squash-can-change-path-3.pdf b/main/_downloads/0b4799657e877d5b1b4cacd9b2acb170/why-squash-can-change-path-3.pdf index 1bac7b6f..a2cf8dad 100644 Binary files a/main/_downloads/0b4799657e877d5b1b4cacd9b2acb170/why-squash-can-change-path-3.pdf and b/main/_downloads/0b4799657e877d5b1b4cacd9b2acb170/why-squash-can-change-path-3.pdf differ diff --git a/main/_downloads/14cd9f05ba952a1aeae7bc548b9fd177/scanspec-specs-3.pdf b/main/_downloads/14cd9f05ba952a1aeae7bc548b9fd177/scanspec-specs-3.pdf index 7b5976e2..a30bf151 100644 Binary files a/main/_downloads/14cd9f05ba952a1aeae7bc548b9fd177/scanspec-specs-3.pdf and b/main/_downloads/14cd9f05ba952a1aeae7bc548b9fd177/scanspec-specs-3.pdf differ diff --git a/main/_downloads/29f8e9f676c07ef454b88a78fef753ad/scanspec-specs-10.pdf b/main/_downloads/29f8e9f676c07ef454b88a78fef753ad/scanspec-specs-10.pdf index a2540711..7e782ecc 100644 Binary files a/main/_downloads/29f8e9f676c07ef454b88a78fef753ad/scanspec-specs-10.pdf and b/main/_downloads/29f8e9f676c07ef454b88a78fef753ad/scanspec-specs-10.pdf differ diff --git a/main/_downloads/32c9e69b107f5cd11ed75edfef7a521c/creating-a-spec-4.pdf b/main/_downloads/32c9e69b107f5cd11ed75edfef7a521c/creating-a-spec-4.pdf index 3698de05..39d999e6 100644 Binary files a/main/_downloads/32c9e69b107f5cd11ed75edfef7a521c/creating-a-spec-4.pdf and b/main/_downloads/32c9e69b107f5cd11ed75edfef7a521c/creating-a-spec-4.pdf differ diff --git a/main/_downloads/36360e8aeabfd64e7339de3c85a6a2ae/scanspec-specs-2.pdf b/main/_downloads/36360e8aeabfd64e7339de3c85a6a2ae/scanspec-specs-2.pdf index 00ee1ba6..41241c11 100644 Binary files a/main/_downloads/36360e8aeabfd64e7339de3c85a6a2ae/scanspec-specs-2.pdf and b/main/_downloads/36360e8aeabfd64e7339de3c85a6a2ae/scanspec-specs-2.pdf differ diff --git a/main/_downloads/4cff00b0b1d9fd7cbd80ee99b1324784/scanspec-specs-13.pdf b/main/_downloads/4cff00b0b1d9fd7cbd80ee99b1324784/scanspec-specs-13.pdf index f279f87b..92d4bd6a 100644 Binary files a/main/_downloads/4cff00b0b1d9fd7cbd80ee99b1324784/scanspec-specs-13.pdf and b/main/_downloads/4cff00b0b1d9fd7cbd80ee99b1324784/scanspec-specs-13.pdf differ diff --git a/main/_downloads/4e6a723d5cba2932d0dc34c140576fd6/scanspec-specs-8.pdf b/main/_downloads/4e6a723d5cba2932d0dc34c140576fd6/scanspec-specs-8.pdf index 955d8833..ca979545 100644 Binary files a/main/_downloads/4e6a723d5cba2932d0dc34c140576fd6/scanspec-specs-8.pdf and b/main/_downloads/4e6a723d5cba2932d0dc34c140576fd6/scanspec-specs-8.pdf differ diff --git a/main/_downloads/56bb872d1a387f9c4a1e9fd60023d0ad/scanspec-regions-4.pdf b/main/_downloads/56bb872d1a387f9c4a1e9fd60023d0ad/scanspec-regions-4.pdf index bdac1149..b0d6563f 100644 Binary files a/main/_downloads/56bb872d1a387f9c4a1e9fd60023d0ad/scanspec-regions-4.pdf and b/main/_downloads/56bb872d1a387f9c4a1e9fd60023d0ad/scanspec-regions-4.pdf differ diff --git a/main/_downloads/594f21876b9d2230f2a0af7771fd53e3/scanspec-regions-2.pdf b/main/_downloads/594f21876b9d2230f2a0af7771fd53e3/scanspec-regions-2.pdf index dec0d4eb..c764e047 100644 Binary files a/main/_downloads/594f21876b9d2230f2a0af7771fd53e3/scanspec-regions-2.pdf and b/main/_downloads/594f21876b9d2230f2a0af7771fd53e3/scanspec-regions-2.pdf differ diff --git a/main/_downloads/59ccb090bb2d3360ace4709fff9b5b3b/creating-a-spec-1.pdf b/main/_downloads/59ccb090bb2d3360ace4709fff9b5b3b/creating-a-spec-1.pdf index 59fbfa61..47ab3c2c 100644 Binary files a/main/_downloads/59ccb090bb2d3360ace4709fff9b5b3b/creating-a-spec-1.pdf and b/main/_downloads/59ccb090bb2d3360ace4709fff9b5b3b/creating-a-spec-1.pdf differ diff --git a/main/_downloads/5c0624426b92b4d678699185e497f06b/creating-a-spec-6.pdf b/main/_downloads/5c0624426b92b4d678699185e497f06b/creating-a-spec-6.pdf index 41ab322b..04ce28b0 100644 Binary files a/main/_downloads/5c0624426b92b4d678699185e497f06b/creating-a-spec-6.pdf and b/main/_downloads/5c0624426b92b4d678699185e497f06b/creating-a-spec-6.pdf differ diff --git a/main/_downloads/5f4cbd3d9eca3474f783397c1af34245/scanspec-specs-14.pdf b/main/_downloads/5f4cbd3d9eca3474f783397c1af34245/scanspec-specs-14.pdf index 0991c73f..8b5c3fda 100644 Binary files a/main/_downloads/5f4cbd3d9eca3474f783397c1af34245/scanspec-specs-14.pdf and b/main/_downloads/5f4cbd3d9eca3474f783397c1af34245/scanspec-specs-14.pdf differ diff --git a/main/_downloads/6377083c2cf9e1c6c2ce2f15c65b9035/scanspec-specs-12.pdf b/main/_downloads/6377083c2cf9e1c6c2ce2f15c65b9035/scanspec-specs-12.pdf index 1c868938..138c453d 100644 Binary files a/main/_downloads/6377083c2cf9e1c6c2ce2f15c65b9035/scanspec-specs-12.pdf and b/main/_downloads/6377083c2cf9e1c6c2ce2f15c65b9035/scanspec-specs-12.pdf differ diff --git a/main/_downloads/6b2bfdefec22ee159c8ced5f7866a2cb/why-squash-can-change-path-4.pdf b/main/_downloads/6b2bfdefec22ee159c8ced5f7866a2cb/why-squash-can-change-path-4.pdf index 0b9dbc12..528d4455 100644 Binary files a/main/_downloads/6b2bfdefec22ee159c8ced5f7866a2cb/why-squash-can-change-path-4.pdf and b/main/_downloads/6b2bfdefec22ee159c8ced5f7866a2cb/why-squash-can-change-path-4.pdf differ diff --git a/main/_downloads/6c39d5369cd428a1fc9b6f8931f5af16/scanspec-regions-3.pdf b/main/_downloads/6c39d5369cd428a1fc9b6f8931f5af16/scanspec-regions-3.pdf index 67bad5ed..e88c0d27 100644 Binary files a/main/_downloads/6c39d5369cd428a1fc9b6f8931f5af16/scanspec-regions-3.pdf and b/main/_downloads/6c39d5369cd428a1fc9b6f8931f5af16/scanspec-regions-3.pdf differ diff --git a/main/_downloads/765eb3a3427fe6d21b1a1aa535319276/scanspec-specs-15.pdf b/main/_downloads/765eb3a3427fe6d21b1a1aa535319276/scanspec-specs-15.pdf index 1b88a4a1..00b888c4 100644 Binary files a/main/_downloads/765eb3a3427fe6d21b1a1aa535319276/scanspec-specs-15.pdf and b/main/_downloads/765eb3a3427fe6d21b1a1aa535319276/scanspec-specs-15.pdf differ diff --git a/main/_downloads/8def2e8f1cf11e2f6361b9872d5c1f96/scanspec-specs-5.pdf b/main/_downloads/8def2e8f1cf11e2f6361b9872d5c1f96/scanspec-specs-5.pdf index 694e6508..d6eb9f39 100644 Binary files a/main/_downloads/8def2e8f1cf11e2f6361b9872d5c1f96/scanspec-specs-5.pdf and b/main/_downloads/8def2e8f1cf11e2f6361b9872d5c1f96/scanspec-specs-5.pdf differ diff --git a/main/_downloads/90481c9e5c2b3588d1b16f603ccb3a86/creating-a-spec-3.pdf b/main/_downloads/90481c9e5c2b3588d1b16f603ccb3a86/creating-a-spec-3.pdf index 074d2a1e..8c5612ed 100644 Binary files a/main/_downloads/90481c9e5c2b3588d1b16f603ccb3a86/creating-a-spec-3.pdf and b/main/_downloads/90481c9e5c2b3588d1b16f603ccb3a86/creating-a-spec-3.pdf differ diff --git a/main/_downloads/a3e641038fd95a120295f2d3ec2190b6/scanspec-specs-16.pdf b/main/_downloads/a3e641038fd95a120295f2d3ec2190b6/scanspec-specs-16.pdf index 6cf6e227..b7c51caf 100644 Binary files a/main/_downloads/a3e641038fd95a120295f2d3ec2190b6/scanspec-specs-16.pdf and b/main/_downloads/a3e641038fd95a120295f2d3ec2190b6/scanspec-specs-16.pdf differ diff --git a/main/_downloads/aaf02e051399c63656daa735de933754/scanspec-specs-4.pdf b/main/_downloads/aaf02e051399c63656daa735de933754/scanspec-specs-4.pdf index 9d5acb18..bbff445c 100644 Binary files a/main/_downloads/aaf02e051399c63656daa735de933754/scanspec-specs-4.pdf and b/main/_downloads/aaf02e051399c63656daa735de933754/scanspec-specs-4.pdf differ diff --git a/main/_downloads/b93b66585638eb26b1622a0b98b703fd/scanspec-specs-6.pdf b/main/_downloads/b93b66585638eb26b1622a0b98b703fd/scanspec-specs-6.pdf index 4f573a1b..1084b9a6 100644 Binary files a/main/_downloads/b93b66585638eb26b1622a0b98b703fd/scanspec-specs-6.pdf and b/main/_downloads/b93b66585638eb26b1622a0b98b703fd/scanspec-specs-6.pdf differ diff --git a/main/_downloads/bd59a3a4d280d4586f4bb2550db6f079/scanspec-specs-7.pdf b/main/_downloads/bd59a3a4d280d4586f4bb2550db6f079/scanspec-specs-7.pdf index cb5a3504..82082c08 100644 Binary files a/main/_downloads/bd59a3a4d280d4586f4bb2550db6f079/scanspec-specs-7.pdf and b/main/_downloads/bd59a3a4d280d4586f4bb2550db6f079/scanspec-specs-7.pdf differ diff --git a/main/_downloads/c2faec58e8a7872b8c73e00e780c4f8b/creating-a-spec-2.pdf b/main/_downloads/c2faec58e8a7872b8c73e00e780c4f8b/creating-a-spec-2.pdf index f097ac22..f5ea6836 100644 Binary files a/main/_downloads/c2faec58e8a7872b8c73e00e780c4f8b/creating-a-spec-2.pdf and b/main/_downloads/c2faec58e8a7872b8c73e00e780c4f8b/creating-a-spec-2.pdf differ diff --git a/main/_downloads/c65de3ee054161d71e4983fd6c960f0d/scanspec-plot-1.pdf b/main/_downloads/c65de3ee054161d71e4983fd6c960f0d/scanspec-plot-1.pdf index de8f9f1a..70969591 100644 Binary files a/main/_downloads/c65de3ee054161d71e4983fd6c960f0d/scanspec-plot-1.pdf and b/main/_downloads/c65de3ee054161d71e4983fd6c960f0d/scanspec-plot-1.pdf differ diff --git a/main/_downloads/d4a857bafcf09d241d2ddbc974c3eab8/scanspec-specs-1.pdf b/main/_downloads/d4a857bafcf09d241d2ddbc974c3eab8/scanspec-specs-1.pdf index 8f2354b0..86ac5a17 100644 Binary files a/main/_downloads/d4a857bafcf09d241d2ddbc974c3eab8/scanspec-specs-1.pdf and b/main/_downloads/d4a857bafcf09d241d2ddbc974c3eab8/scanspec-specs-1.pdf differ diff --git a/main/_downloads/d951a913ef49c5656aca72d4ec3d6127/scanspec-specs-11.pdf b/main/_downloads/d951a913ef49c5656aca72d4ec3d6127/scanspec-specs-11.pdf index 59293f22..7e5faa28 100644 Binary files a/main/_downloads/d951a913ef49c5656aca72d4ec3d6127/scanspec-specs-11.pdf and b/main/_downloads/d951a913ef49c5656aca72d4ec3d6127/scanspec-specs-11.pdf differ diff --git a/main/_downloads/df45abd6cf3a536dc40edb8915007a0e/scanspec-specs-9.pdf b/main/_downloads/df45abd6cf3a536dc40edb8915007a0e/scanspec-specs-9.pdf index e7ff43db..f6e0252b 100644 Binary files a/main/_downloads/df45abd6cf3a536dc40edb8915007a0e/scanspec-specs-9.pdf and b/main/_downloads/df45abd6cf3a536dc40edb8915007a0e/scanspec-specs-9.pdf differ diff --git a/main/_downloads/e97e6c4ea088783de917c4b5859e1595/why-squash-can-change-path-1.pdf b/main/_downloads/e97e6c4ea088783de917c4b5859e1595/why-squash-can-change-path-1.pdf index 5e822bf3..84916a1a 100644 Binary files a/main/_downloads/e97e6c4ea088783de917c4b5859e1595/why-squash-can-change-path-1.pdf and b/main/_downloads/e97e6c4ea088783de917c4b5859e1595/why-squash-can-change-path-1.pdf differ diff --git a/main/_downloads/ec8d232d0953cdaac6529cb67293b0e8/creating-a-spec-5.pdf b/main/_downloads/ec8d232d0953cdaac6529cb67293b0e8/creating-a-spec-5.pdf index 72be3460..9332f238 100644 Binary files a/main/_downloads/ec8d232d0953cdaac6529cb67293b0e8/creating-a-spec-5.pdf and b/main/_downloads/ec8d232d0953cdaac6529cb67293b0e8/creating-a-spec-5.pdf differ diff --git a/main/_downloads/edf4182424d7c4118287d2ea50bef6bb/why-squash-can-change-path-2.pdf b/main/_downloads/edf4182424d7c4118287d2ea50bef6bb/why-squash-can-change-path-2.pdf index 154d5a38..5a0d61e2 100644 Binary files a/main/_downloads/edf4182424d7c4118287d2ea50bef6bb/why-squash-can-change-path-2.pdf and b/main/_downloads/edf4182424d7c4118287d2ea50bef6bb/why-squash-can-change-path-2.pdf differ diff --git a/main/_modules/index.html b/main/_modules/index.html index 3a290414..8841efc3 100644 --- a/main/_modules/index.html +++ b/main/_modules/index.html @@ -7,7 +7,7 @@ - Overview: module code — scanspec 0.7.4.dev1+g4deecf8b documentation + Overview: module code — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -29,7 +29,7 @@ - + @@ -39,8 +39,8 @@ - - + + diff --git a/main/_modules/scanspec/core.html b/main/_modules/scanspec/core.html index 75ef7be6..351379af 100644 --- a/main/_modules/scanspec/core.html +++ b/main/_modules/scanspec/core.html @@ -7,7 +7,7 @@ - scanspec.core — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec.core — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -29,7 +29,7 @@ - + @@ -39,8 +39,8 @@ - - + + diff --git a/main/_modules/scanspec/plot.html b/main/_modules/scanspec/plot.html index ac018a7a..0993f8d5 100644 --- a/main/_modules/scanspec/plot.html +++ b/main/_modules/scanspec/plot.html @@ -7,7 +7,7 @@ - scanspec.plot — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec.plot — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -29,7 +29,7 @@ - + @@ -39,8 +39,8 @@ - - + + diff --git a/main/_modules/scanspec/regions.html b/main/_modules/scanspec/regions.html index 5fd49c9f..70c53424 100644 --- a/main/_modules/scanspec/regions.html +++ b/main/_modules/scanspec/regions.html @@ -7,7 +7,7 @@ - scanspec.regions — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec.regions — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -29,7 +29,7 @@ - + @@ -39,8 +39,8 @@ - - + + diff --git a/main/_modules/scanspec/specs.html b/main/_modules/scanspec/specs.html index 4ce9a6aa..91e22d4b 100644 --- a/main/_modules/scanspec/specs.html +++ b/main/_modules/scanspec/specs.html @@ -7,7 +7,7 @@ - scanspec.specs — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec.specs — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -29,7 +29,7 @@ - + @@ -39,8 +39,8 @@ - - + + diff --git a/main/_static/basic.css b/main/_static/basic.css index 2af6139e..2a9e4114 100644 --- a/main/_static/basic.css +++ b/main/_static/basic.css @@ -1,12 +1,5 @@ /* - * basic.css - * ~~~~~~~~~ - * * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ /* -- main layout ----------------------------------------------------------- */ @@ -115,15 +108,11 @@ img { /* -- search page ----------------------------------------------------------- */ ul.search { - margin: 10px 0 0 20px; - padding: 0; + margin-top: 10px; } ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; + padding: 5px 0; } ul.search li a { diff --git a/main/_static/doctools.js b/main/_static/doctools.js index 4d67807d..0398ebb9 100644 --- a/main/_static/doctools.js +++ b/main/_static/doctools.js @@ -1,12 +1,5 @@ /* - * doctools.js - * ~~~~~~~~~~~ - * * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js index b2ff5646..7db3343a 100644 --- a/main/_static/documentation_options.js +++ b/main/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.7.4.dev1+g4deecf8b', + VERSION: '0.7.5.dev2+g6291ec72', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/main/_static/graphviz.css b/main/_static/graphviz.css index 027576e3..30f3837b 100644 --- a/main/_static/graphviz.css +++ b/main/_static/graphviz.css @@ -1,12 +1,5 @@ /* - * graphviz.css - * ~~~~~~~~~~~~ - * * Sphinx stylesheet -- graphviz extension. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ img.graphviz { diff --git a/main/_static/language_data.js b/main/_static/language_data.js index 367b8ed8..c7fe6c6f 100644 --- a/main/_static/language_data.js +++ b/main/_static/language_data.js @@ -1,13 +1,6 @@ /* - * language_data.js - * ~~~~~~~~~~~~~~~~ - * * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; diff --git a/main/_static/searchtools.js b/main/_static/searchtools.js index b08d58c9..2c774d17 100644 --- a/main/_static/searchtools.js +++ b/main/_static/searchtools.js @@ -1,12 +1,5 @@ /* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * */ "use strict"; @@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") { // and returns the new score. /* score: result => { - const [docname, title, anchor, descr, score, filename] = result + const [docname, title, anchor, descr, score, filename, kind] = result return score }, */ @@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") { }; } +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + const _removeChildren = (element) => { while (element && element.lastChild) element.removeChild(element.lastChild); }; @@ -64,9 +65,13 @@ const _displayItem = (item, searchTerms, highlightTerms) => { const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; const contentRoot = document.documentElement.dataset.content_root; - const [docName, title, anchor, descr, score, _filename] = item; + const [docName, title, anchor, descr, score, _filename, kind] = item; let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); let requestUrl; let linkUrl; if (docBuilder === "dirhtml") { @@ -115,8 +120,10 @@ const _finishSearch = (resultCount) => { "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." ); else - Search.status.innerText = _( - "Search finished, found ${resultCount} page(s) matching the search query." + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, ).replace('${resultCount}', resultCount); }; const _displayNextItem = ( @@ -138,7 +145,7 @@ const _displayNextItem = ( else _finishSearch(resultCount); }; // Helper function used by query() to order search results. -// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. // Order the results by score (in opposite order of appearance, since the // `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. const _orderResultsByScoreThenName = (a, b) => { @@ -248,6 +255,7 @@ const Search = { searchSummary.classList.add("search-summary"); searchSummary.innerText = ""; const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); searchList.classList.add("search"); const out = document.getElementById("search-results"); @@ -318,7 +326,7 @@ const Search = { const indexEntries = Search._index.indexentries; // Collect multiple result groups to be sorted separately and then ordered. - // Each is an array of [docname, title, anchor, descr, score, filename]. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. const normalResults = []; const nonMainIndexResults = []; @@ -337,6 +345,7 @@ const Search = { null, score + boost, filenames[file], + SearchResultKind.title, ]); } } @@ -354,6 +363,7 @@ const Search = { null, score, filenames[file], + SearchResultKind.index, ]; if (isMain) { normalResults.push(result); @@ -475,6 +485,7 @@ const Search = { descr, score, filenames[match[0]], + SearchResultKind.object, ]); }; Object.keys(objects).forEach((prefix) => @@ -585,6 +596,7 @@ const Search = { null, score, filenames[file], + SearchResultKind.text, ]); } return results; diff --git a/main/explanations.html b/main/explanations.html index fcbe4ec7..1fe1edf7 100644 --- a/main/explanations.html +++ b/main/explanations.html @@ -8,7 +8,7 @@ - Explanations — scanspec 0.7.4.dev1+g4deecf8b documentation + Explanations — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/explanations/decisions.html b/main/explanations/decisions.html index b1d10b09..f6c8b47a 100644 --- a/main/explanations/decisions.html +++ b/main/explanations/decisions.html @@ -8,7 +8,7 @@ - Architectural Decision Records — scanspec 0.7.4.dev1+g4deecf8b documentation + Architectural Decision Records — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/explanations/decisions/0001-record-architecture-decisions.html b/main/explanations/decisions/0001-record-architecture-decisions.html index 064f66f1..6f75963a 100644 --- a/main/explanations/decisions/0001-record-architecture-decisions.html +++ b/main/explanations/decisions/0001-record-architecture-decisions.html @@ -8,7 +8,7 @@ - 1. Record architecture decisions — scanspec 0.7.4.dev1+g4deecf8b documentation + 1. Record architecture decisions — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/explanations/decisions/0002-switched-to-python-copier-template.html b/main/explanations/decisions/0002-switched-to-python-copier-template.html index 31b155f7..30ee680a 100644 --- a/main/explanations/decisions/0002-switched-to-python-copier-template.html +++ b/main/explanations/decisions/0002-switched-to-python-copier-template.html @@ -8,7 +8,7 @@ - 2. Adopt python-copier-template for project structure — scanspec 0.7.4.dev1+g4deecf8b documentation + 2. Adopt python-copier-template for project structure — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/explanations/technical-terms.html b/main/explanations/technical-terms.html index 5e20205a..0db2ab58 100644 --- a/main/explanations/technical-terms.html +++ b/main/explanations/technical-terms.html @@ -8,7 +8,7 @@ - Technical Terms — scanspec 0.7.4.dev1+g4deecf8b documentation + Technical Terms — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/explanations/why-squash-can-change-path.html b/main/explanations/why-squash-can-change-path.html index cda1ea5b..e60ad744 100644 --- a/main/explanations/why-squash-can-change-path.html +++ b/main/explanations/why-squash-can-change-path.html @@ -8,7 +8,7 @@ - Why Squash (and Mask) can change the Path — scanspec 0.7.4.dev1+g4deecf8b documentation + Why Squash (and Mask) can change the Path — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/explanations/why-stack-frames.html b/main/explanations/why-stack-frames.html index 0515ca9a..60e484ad 100644 --- a/main/explanations/why-stack-frames.html +++ b/main/explanations/why-stack-frames.html @@ -8,7 +8,7 @@ - Why create a stack of Frames? — scanspec 0.7.4.dev1+g4deecf8b documentation + Why create a stack of Frames? — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/genindex.html b/main/genindex.html index b5d98d00..97e56fdd 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -7,7 +7,7 @@ - Index — scanspec 0.7.4.dev1+g4deecf8b documentation + Index — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -29,7 +29,7 @@ - + @@ -39,8 +39,8 @@ - - + + diff --git a/main/how-to.html b/main/how-to.html index 44817608..3ed12035 100644 --- a/main/how-to.html +++ b/main/how-to.html @@ -8,7 +8,7 @@ - How-to Guides — scanspec 0.7.4.dev1+g4deecf8b documentation + How-to Guides — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/how-to/contribute.html b/main/how-to/contribute.html index 048f7e8f..8a98ab39 100644 --- a/main/how-to/contribute.html +++ b/main/how-to/contribute.html @@ -8,7 +8,7 @@ - Contribute to the project — scanspec 0.7.4.dev1+g4deecf8b documentation + Contribute to the project — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/how-to/iterate-a-spec.html b/main/how-to/iterate-a-spec.html index 021c8a34..ec8032be 100644 --- a/main/how-to/iterate-a-spec.html +++ b/main/how-to/iterate-a-spec.html @@ -8,7 +8,7 @@ - How to Iterate a Spec — scanspec 0.7.4.dev1+g4deecf8b documentation + How to Iterate a Spec — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/how-to/run-container.html b/main/how-to/run-container.html index 89616700..93d31198 100644 --- a/main/how-to/run-container.html +++ b/main/how-to/run-container.html @@ -8,7 +8,7 @@ - Run in a container — scanspec 0.7.4.dev1+g4deecf8b documentation + Run in a container — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/how-to/serialize-a-spec.html b/main/how-to/serialize-a-spec.html index 2f0e68a4..ecc2ef17 100644 --- a/main/how-to/serialize-a-spec.html +++ b/main/how-to/serialize-a-spec.html @@ -8,7 +8,7 @@ - How to Serialize and Deserialize a Spec — scanspec 0.7.4.dev1+g4deecf8b documentation + How to Serialize and Deserialize a Spec — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/http-routingtable.html b/main/http-routingtable.html index f5e2ffff..b52a67d5 100644 --- a/main/http-routingtable.html +++ b/main/http-routingtable.html @@ -7,7 +7,7 @@ - HTTP Routing Table — scanspec 0.7.4.dev1+g4deecf8b documentation + HTTP Routing Table — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -29,7 +29,7 @@ - + @@ -39,8 +39,8 @@ - - + + diff --git a/main/index.html b/main/index.html index baa8318a..f5346201 100644 --- a/main/index.html +++ b/main/index.html @@ -8,7 +8,7 @@ - scanspec — scanspec 0.7.4.dev1+g4deecf8b documentation + scanspec — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/plot_directive/_api/scanspec-plot-1.pdf b/main/plot_directive/_api/scanspec-plot-1.pdf index de8f9f1a..70969591 100644 Binary files a/main/plot_directive/_api/scanspec-plot-1.pdf and b/main/plot_directive/_api/scanspec-plot-1.pdf differ diff --git a/main/plot_directive/_api/scanspec-regions-1.pdf b/main/plot_directive/_api/scanspec-regions-1.pdf index 95316ca0..69728191 100644 Binary files a/main/plot_directive/_api/scanspec-regions-1.pdf and b/main/plot_directive/_api/scanspec-regions-1.pdf differ diff --git a/main/plot_directive/_api/scanspec-regions-2.pdf b/main/plot_directive/_api/scanspec-regions-2.pdf index dec0d4eb..c764e047 100644 Binary files a/main/plot_directive/_api/scanspec-regions-2.pdf and b/main/plot_directive/_api/scanspec-regions-2.pdf differ diff --git a/main/plot_directive/_api/scanspec-regions-3.pdf b/main/plot_directive/_api/scanspec-regions-3.pdf index 67bad5ed..e88c0d27 100644 Binary files a/main/plot_directive/_api/scanspec-regions-3.pdf and b/main/plot_directive/_api/scanspec-regions-3.pdf differ diff --git a/main/plot_directive/_api/scanspec-regions-4.pdf b/main/plot_directive/_api/scanspec-regions-4.pdf index bdac1149..b0d6563f 100644 Binary files a/main/plot_directive/_api/scanspec-regions-4.pdf and b/main/plot_directive/_api/scanspec-regions-4.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-1.pdf b/main/plot_directive/_api/scanspec-specs-1.pdf index 8f2354b0..86ac5a17 100644 Binary files a/main/plot_directive/_api/scanspec-specs-1.pdf and b/main/plot_directive/_api/scanspec-specs-1.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-10.pdf b/main/plot_directive/_api/scanspec-specs-10.pdf index a2540711..7e782ecc 100644 Binary files a/main/plot_directive/_api/scanspec-specs-10.pdf and b/main/plot_directive/_api/scanspec-specs-10.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-11.pdf b/main/plot_directive/_api/scanspec-specs-11.pdf index 59293f22..7e5faa28 100644 Binary files a/main/plot_directive/_api/scanspec-specs-11.pdf and b/main/plot_directive/_api/scanspec-specs-11.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-12.pdf b/main/plot_directive/_api/scanspec-specs-12.pdf index 1c868938..138c453d 100644 Binary files a/main/plot_directive/_api/scanspec-specs-12.pdf and b/main/plot_directive/_api/scanspec-specs-12.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-13.pdf b/main/plot_directive/_api/scanspec-specs-13.pdf index f279f87b..92d4bd6a 100644 Binary files a/main/plot_directive/_api/scanspec-specs-13.pdf and b/main/plot_directive/_api/scanspec-specs-13.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-14.pdf b/main/plot_directive/_api/scanspec-specs-14.pdf index 0991c73f..8b5c3fda 100644 Binary files a/main/plot_directive/_api/scanspec-specs-14.pdf and b/main/plot_directive/_api/scanspec-specs-14.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-15.pdf b/main/plot_directive/_api/scanspec-specs-15.pdf index 1b88a4a1..00b888c4 100644 Binary files a/main/plot_directive/_api/scanspec-specs-15.pdf and b/main/plot_directive/_api/scanspec-specs-15.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-16.pdf b/main/plot_directive/_api/scanspec-specs-16.pdf index 6cf6e227..b7c51caf 100644 Binary files a/main/plot_directive/_api/scanspec-specs-16.pdf and b/main/plot_directive/_api/scanspec-specs-16.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-2.pdf b/main/plot_directive/_api/scanspec-specs-2.pdf index 00ee1ba6..41241c11 100644 Binary files a/main/plot_directive/_api/scanspec-specs-2.pdf and b/main/plot_directive/_api/scanspec-specs-2.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-3.pdf b/main/plot_directive/_api/scanspec-specs-3.pdf index 7b5976e2..a30bf151 100644 Binary files a/main/plot_directive/_api/scanspec-specs-3.pdf and b/main/plot_directive/_api/scanspec-specs-3.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-4.pdf b/main/plot_directive/_api/scanspec-specs-4.pdf index 9d5acb18..bbff445c 100644 Binary files a/main/plot_directive/_api/scanspec-specs-4.pdf and b/main/plot_directive/_api/scanspec-specs-4.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-5.pdf b/main/plot_directive/_api/scanspec-specs-5.pdf index 694e6508..d6eb9f39 100644 Binary files a/main/plot_directive/_api/scanspec-specs-5.pdf and b/main/plot_directive/_api/scanspec-specs-5.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-6.pdf b/main/plot_directive/_api/scanspec-specs-6.pdf index 4f573a1b..1084b9a6 100644 Binary files a/main/plot_directive/_api/scanspec-specs-6.pdf and b/main/plot_directive/_api/scanspec-specs-6.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-7.pdf b/main/plot_directive/_api/scanspec-specs-7.pdf index cb5a3504..82082c08 100644 Binary files a/main/plot_directive/_api/scanspec-specs-7.pdf and b/main/plot_directive/_api/scanspec-specs-7.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-8.pdf b/main/plot_directive/_api/scanspec-specs-8.pdf index 955d8833..ca979545 100644 Binary files a/main/plot_directive/_api/scanspec-specs-8.pdf and b/main/plot_directive/_api/scanspec-specs-8.pdf differ diff --git a/main/plot_directive/_api/scanspec-specs-9.pdf b/main/plot_directive/_api/scanspec-specs-9.pdf index e7ff43db..f6e0252b 100644 Binary files a/main/plot_directive/_api/scanspec-specs-9.pdf and b/main/plot_directive/_api/scanspec-specs-9.pdf differ diff --git a/main/plot_directive/explanations/why-squash-can-change-path-1.pdf b/main/plot_directive/explanations/why-squash-can-change-path-1.pdf index 5e822bf3..84916a1a 100644 Binary files a/main/plot_directive/explanations/why-squash-can-change-path-1.pdf and b/main/plot_directive/explanations/why-squash-can-change-path-1.pdf differ diff --git a/main/plot_directive/explanations/why-squash-can-change-path-2.pdf b/main/plot_directive/explanations/why-squash-can-change-path-2.pdf index 154d5a38..5a0d61e2 100644 Binary files a/main/plot_directive/explanations/why-squash-can-change-path-2.pdf and b/main/plot_directive/explanations/why-squash-can-change-path-2.pdf differ diff --git a/main/plot_directive/explanations/why-squash-can-change-path-3.pdf b/main/plot_directive/explanations/why-squash-can-change-path-3.pdf index 1bac7b6f..a2cf8dad 100644 Binary files a/main/plot_directive/explanations/why-squash-can-change-path-3.pdf and b/main/plot_directive/explanations/why-squash-can-change-path-3.pdf differ diff --git a/main/plot_directive/explanations/why-squash-can-change-path-4.pdf b/main/plot_directive/explanations/why-squash-can-change-path-4.pdf index 0b9dbc12..528d4455 100644 Binary files a/main/plot_directive/explanations/why-squash-can-change-path-4.pdf and b/main/plot_directive/explanations/why-squash-can-change-path-4.pdf differ diff --git a/main/plot_directive/tutorials/creating-a-spec-1.pdf b/main/plot_directive/tutorials/creating-a-spec-1.pdf index 59fbfa61..47ab3c2c 100644 Binary files a/main/plot_directive/tutorials/creating-a-spec-1.pdf and b/main/plot_directive/tutorials/creating-a-spec-1.pdf differ diff --git a/main/plot_directive/tutorials/creating-a-spec-2.pdf b/main/plot_directive/tutorials/creating-a-spec-2.pdf index f097ac22..f5ea6836 100644 Binary files a/main/plot_directive/tutorials/creating-a-spec-2.pdf and b/main/plot_directive/tutorials/creating-a-spec-2.pdf differ diff --git a/main/plot_directive/tutorials/creating-a-spec-3.pdf b/main/plot_directive/tutorials/creating-a-spec-3.pdf index 074d2a1e..8c5612ed 100644 Binary files a/main/plot_directive/tutorials/creating-a-spec-3.pdf and b/main/plot_directive/tutorials/creating-a-spec-3.pdf differ diff --git a/main/plot_directive/tutorials/creating-a-spec-4.pdf b/main/plot_directive/tutorials/creating-a-spec-4.pdf index 3698de05..39d999e6 100644 Binary files a/main/plot_directive/tutorials/creating-a-spec-4.pdf and b/main/plot_directive/tutorials/creating-a-spec-4.pdf differ diff --git a/main/plot_directive/tutorials/creating-a-spec-5.pdf b/main/plot_directive/tutorials/creating-a-spec-5.pdf index 72be3460..9332f238 100644 Binary files a/main/plot_directive/tutorials/creating-a-spec-5.pdf and b/main/plot_directive/tutorials/creating-a-spec-5.pdf differ diff --git a/main/plot_directive/tutorials/creating-a-spec-6.pdf b/main/plot_directive/tutorials/creating-a-spec-6.pdf index 41ab322b..04ce28b0 100644 Binary files a/main/plot_directive/tutorials/creating-a-spec-6.pdf and b/main/plot_directive/tutorials/creating-a-spec-6.pdf differ diff --git a/main/py-modindex.html b/main/py-modindex.html index bfe866d1..9590265d 100644 --- a/main/py-modindex.html +++ b/main/py-modindex.html @@ -7,7 +7,7 @@ - Python Module Index — scanspec 0.7.4.dev1+g4deecf8b documentation + Python Module Index — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -29,7 +29,7 @@ - + @@ -39,8 +39,8 @@ - - + + diff --git a/main/reference.html b/main/reference.html index 16f132e8..876d0b20 100644 --- a/main/reference.html +++ b/main/reference.html @@ -8,7 +8,7 @@ - Reference — scanspec 0.7.4.dev1+g4deecf8b documentation + Reference — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/reference/rest_api.html b/main/reference/rest_api.html index cdf34000..6d3b089d 100644 --- a/main/reference/rest_api.html +++ b/main/reference/rest_api.html @@ -8,7 +8,7 @@ - REST API — scanspec 0.7.4.dev1+g4deecf8b documentation + REST API — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/search.html b/main/search.html index 29052fd8..b63000d4 100644 --- a/main/search.html +++ b/main/search.html @@ -6,7 +6,7 @@ - Search - scanspec 0.7.4.dev1+g4deecf8b documentation + Search - scanspec 0.7.5.dev2+g6291ec72 documentation @@ -28,7 +28,7 @@ - + @@ -38,8 +38,8 @@ - - + + diff --git a/main/searchindex.js b/main/searchindex.js index aedd27bd..a153ccf6 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"1. Record architecture decisions": [[8, null]], "2. Adopt python-copier-template for project structure": [[9, null]], "API": [[0, null]], "An Example": [[12, "an-example"]], "Architectural Decision Records": [[7, null]], "Axis": [[10, "axis"]], "Check your version of python": [[24, "check-your-version-of-python"]], "Code Coverage": [[15, "code-coverage"]], "Conclusion": [[23, "conclusion"]], "Consequences": [[8, "consequences"], [9, "consequences"]], "Context": [[8, "context"], [9, "context"]], "Contribute to the project": [[15, null]], "Create a virtual environment": [[24, "create-a-virtual-environment"]], "Creating a Scan Spec": [[23, null]], "Decision": [[8, "decision"], [9, "decision"]], "Developer Information": [[15, "developer-information"]], "Explanations": [[6, null]], "Frame": [[10, "frame"]], "Generating Midpoints": [[25, "generating-midpoints"]], "Grid": [[23, "grid"]], "How does this stack relate to HDF5 Dimensions?": [[12, "how-does-this-stack-relate-to-hdf5-dimensions"]], "How the documentation is structured": [[19, "how-the-documentation-is-structured"]], "How to Deserialize": [[18, "how-to-deserialize"]], "How to Iterate a Spec": [[16, null]], "How to Serialize": [[18, "how-to-serialize"]], "How to Serialize and Deserialize a Spec": [[18, null]], "How-to Guides": [[14, null]], "If you need to do a fly scan": [[16, "if-you-need-to-do-a-fly-scan"]], "If you need to know whether there is a gap between points": [[16, "if-you-need-to-know-whether-there-is-a-gap-between-points"]], "If you only need the midpoints": [[16, "if-you-only-need-the-midpoints"]], "If you want the most performant option": [[16, "if-you-want-the-most-performant-option"]], "Index": [[13, null]], "Installation": [[24, null]], "Installing the library": [[24, "installing-the-library"]], "Issue or Discussion?": [[15, "issue-or-discussion"]], "Line": [[23, "line"]], "Line with 2 axes": [[23, "line-with-2-axes"]], "Masking with Multiple Regions": [[23, "masking-with-multiple-regions"]], "Masking with Regions": [[23, "masking-with-regions"]], "Path": [[10, "path"]], "Plotting from the commandline": [[23, "plotting-from-the-commandline"]], "Point": [[10, "point"]], "REST API": [[21, null]], "Reference": [[20, null]], "Run in a container": [[17, null]], "Running a REST service for generating points": [[25, null]], "Running the server": [[25, "running-the-server"]], "Snaked Grid": [[23, "snaked-grid"]], "Squash snaked axis into unsnaked odd length axis": [[11, "squash-snaked-axis-into-unsnaked-odd-length-axis"]], "Squash unsnaked axis into a snaked Frames": [[11, "squash-unsnaked-axis-into-a-snaked-frames"]], "Stack of Frames": [[10, "stack-of-frames"]], "Starting the container": [[17, "starting-the-container"]], "Status": [[8, "status"], [9, "status"]], "Technical Terms": [[10, null]], "Tutorials": [[22, null]], "Validating a Spec": [[25, "validating-a-spec"]], "What about Regions?": [[12, "what-about-regions"]], "Why Squash (and Mask) can change the Path": [[11, null]], "Why create a stack of Frames?": [[12, null]], "Why not squash them into a flat sequence?": [[12, "why-not-squash-them-into-a-flat-sequence"]], "Why this matters": [[11, "why-this-matters"]], "scanspec": [[1, null], [19, null]], "scanspec.core": [[2, null]], "scanspec.plot": [[3, null]], "scanspec.regions": [[4, null]], "scanspec.specs": [[5, null]]}, "docnames": ["_api", "_api/scanspec", "_api/scanspec.core", "_api/scanspec.plot", "_api/scanspec.regions", "_api/scanspec.specs", "explanations", "explanations/decisions", "explanations/decisions/0001-record-architecture-decisions", "explanations/decisions/0002-switched-to-python-copier-template", "explanations/technical-terms", "explanations/why-squash-can-change-path", "explanations/why-stack-frames", "genindex", "how-to", "how-to/contribute", "how-to/iterate-a-spec", "how-to/run-container", "how-to/serialize-a-spec", "index", "reference", "reference/rest_api", "tutorials", "tutorials/creating-a-spec", "tutorials/installation", "tutorials/rest-service"], "envversion": {"sphinx": 63, "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}, "filenames": ["_api.rst", "_api/scanspec.rst", "_api/scanspec.core.rst", "_api/scanspec.plot.rst", "_api/scanspec.regions.rst", "_api/scanspec.specs.rst", "explanations.md", "explanations/decisions.md", "explanations/decisions/0001-record-architecture-decisions.md", "explanations/decisions/0002-switched-to-python-copier-template.md", "explanations/technical-terms.rst", "explanations/why-squash-can-change-path.rst", "explanations/why-stack-frames.rst", "genindex.md", "how-to.md", "how-to/contribute.md", "how-to/iterate-a-spec.rst", "how-to/run-container.md", "how-to/serialize-a-spec.rst", "index.md", "reference.md", "reference/rest_api.md", "tutorials.md", "tutorials/creating-a-spec.rst", "tutorials/installation.md", "tutorials/rest-service.rst"], "indexentries": {"__version__ (in module scanspec)": [[1, "scanspec.__version__", false]], "angle (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.angle", false]], "angle (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.angle", false]], "axes (scanspec.core.midpoints property)": [[2, "scanspec.core.Midpoints.axes", false]], "axes() (scanspec.core.frames method)": [[2, "scanspec.core.Frames.axes", false]], "axes() (scanspec.specs.concat method)": [[5, "scanspec.specs.Concat.axes", false]], "axes() (scanspec.specs.line method)": [[5, "scanspec.specs.Line.axes", false]], "axes() (scanspec.specs.mask method)": [[5, "scanspec.specs.Mask.axes", false]], "axes() (scanspec.specs.product method)": [[5, "scanspec.specs.Product.axes", false]], "axes() (scanspec.specs.repeat method)": [[5, "scanspec.specs.Repeat.axes", false]], "axes() (scanspec.specs.snake method)": [[5, "scanspec.specs.Snake.axes", false]], "axes() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.axes", false]], "axes() (scanspec.specs.spiral method)": [[5, "scanspec.specs.Spiral.axes", false]], "axes() (scanspec.specs.squash method)": [[5, "scanspec.specs.Squash.axes", false]], "axes() (scanspec.specs.static method)": [[5, "scanspec.specs.Static.axes", false]], "axes() (scanspec.specs.zip method)": [[5, "scanspec.specs.Zip.axes", false]], "axespoints (in module scanspec.core)": [[2, "scanspec.core.AxesPoints", false]], "axis (class in scanspec.core)": [[2, "scanspec.core.Axis", false]], "axis (scanspec.regions.range attribute)": [[4, "scanspec.regions.Range.axis", false]], "axis (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.axis", false]], "axis (scanspec.specs.static attribute)": [[5, "scanspec.specs.Static.axis", false]], "axis_sets() (scanspec.regions.circle method)": [[4, "scanspec.regions.Circle.axis_sets", false]], "axis_sets() (scanspec.regions.combinationof method)": [[4, "scanspec.regions.CombinationOf.axis_sets", false]], "axis_sets() (scanspec.regions.ellipse method)": [[4, "scanspec.regions.Ellipse.axis_sets", false]], "axis_sets() (scanspec.regions.polygon method)": [[4, "scanspec.regions.Polygon.axis_sets", false]], "axis_sets() (scanspec.regions.range method)": [[4, "scanspec.regions.Range.axis_sets", false]], "axis_sets() (scanspec.regions.rectangle method)": [[4, "scanspec.regions.Rectangle.axis_sets", false]], "axis_sets() (scanspec.regions.region method)": [[4, "scanspec.regions.Region.axis_sets", false]], "bounded() (scanspec.specs.line method)": [[5, "scanspec.specs.Line.bounded", false]], "calculate() (scanspec.specs.concat method)": [[5, "scanspec.specs.Concat.calculate", false]], "calculate() (scanspec.specs.line method)": [[5, "scanspec.specs.Line.calculate", false]], "calculate() (scanspec.specs.mask method)": [[5, "scanspec.specs.Mask.calculate", false]], "calculate() (scanspec.specs.product method)": [[5, "scanspec.specs.Product.calculate", false]], "calculate() (scanspec.specs.repeat method)": [[5, "scanspec.specs.Repeat.calculate", false]], "calculate() (scanspec.specs.snake method)": [[5, "scanspec.specs.Snake.calculate", false]], "calculate() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.calculate", false]], "calculate() (scanspec.specs.spiral method)": [[5, "scanspec.specs.Spiral.calculate", false]], "calculate() (scanspec.specs.squash method)": [[5, "scanspec.specs.Squash.calculate", false]], "calculate() (scanspec.specs.static method)": [[5, "scanspec.specs.Static.calculate", false]], "calculate() (scanspec.specs.zip method)": [[5, "scanspec.specs.Zip.calculate", false]], "check_path_changes (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.check_path_changes", false]], "check_path_changes (scanspec.specs.mask attribute)": [[5, "scanspec.specs.Mask.check_path_changes", false]], "check_path_changes (scanspec.specs.squash attribute)": [[5, "scanspec.specs.Squash.check_path_changes", false]], "concat() (scanspec.core.frames method)": [[2, "scanspec.core.Frames.concat", false]], "concat() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.concat", false]], "consume() (scanspec.core.path method)": [[2, "scanspec.core.Path.consume", false]], "deserialize() (scanspec.regions.region static method)": [[4, "scanspec.regions.Region.deserialize", false]], "deserialize() (scanspec.specs.spec static method)": [[5, "scanspec.specs.Spec.deserialize", false]], "discriminated_union_of_subclasses() (in module scanspec.core)": [[2, "scanspec.core.discriminated_union_of_subclasses", false]], "duration (in module scanspec.specs)": [[5, "scanspec.specs.DURATION", false]], "duration() (scanspec.specs.static method)": [[5, "scanspec.specs.Static.duration", false]], "end_index (scanspec.core.path attribute)": [[2, "scanspec.core.Path.end_index", false]], "extract() (scanspec.core.frames method)": [[2, "scanspec.core.Frames.extract", false]], "extract() (scanspec.core.snakedframes method)": [[2, "scanspec.core.SnakedFrames.extract", false]], "find_regions() (in module scanspec.regions)": [[4, "scanspec.regions.find_regions", false]], "fly() (in module scanspec.specs)": [[5, "scanspec.specs.fly", false]], "frames (class in scanspec.core)": [[2, "scanspec.core.Frames", false]], "frames() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.frames", false]], "from_frames() (scanspec.core.snakedframes class method)": [[2, "scanspec.core.SnakedFrames.from_frames", false]], "gap (scanspec.core.frames attribute)": [[2, "scanspec.core.Frames.gap", false]], "gap (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.gap", false]], "gap (scanspec.specs.repeat attribute)": [[5, "scanspec.specs.Repeat.gap", false]], "gap_between_frames() (in module scanspec.core)": [[2, "scanspec.core.gap_between_frames", false]], "get_mask() (in module scanspec.regions)": [[4, "scanspec.regions.get_mask", false]], "if_instance_do() (in module scanspec.core)": [[2, "scanspec.core.if_instance_do", false]], "index (scanspec.core.path attribute)": [[2, "scanspec.core.Path.index", false]], "inner (scanspec.specs.product attribute)": [[5, "scanspec.specs.Product.inner", false]], "left (scanspec.regions.combinationof attribute)": [[4, "scanspec.regions.CombinationOf.left", false]], "left (scanspec.regions.differenceof attribute)": [[4, "scanspec.regions.DifferenceOf.left", false]], "left (scanspec.regions.intersectionof attribute)": [[4, "scanspec.regions.IntersectionOf.left", false]], "left (scanspec.regions.symmetricdifferenceof attribute)": [[4, "scanspec.regions.SymmetricDifferenceOf.left", false]], "left (scanspec.regions.unionof attribute)": [[4, "scanspec.regions.UnionOf.left", false]], "left (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.left", false]], "left (scanspec.specs.zip attribute)": [[5, "scanspec.specs.Zip.left", false]], "lengths (scanspec.core.path attribute)": [[2, "scanspec.core.Path.lengths", false]], "lower (scanspec.core.frames attribute)": [[2, "scanspec.core.Frames.lower", false]], "mask() (scanspec.regions.circle method)": [[4, "scanspec.regions.Circle.mask", false]], "mask() (scanspec.regions.differenceof method)": [[4, "scanspec.regions.DifferenceOf.mask", false]], "mask() (scanspec.regions.ellipse method)": [[4, "scanspec.regions.Ellipse.mask", false]], "mask() (scanspec.regions.intersectionof method)": [[4, "scanspec.regions.IntersectionOf.mask", false]], "mask() (scanspec.regions.polygon method)": [[4, "scanspec.regions.Polygon.mask", false]], "mask() (scanspec.regions.range method)": [[4, "scanspec.regions.Range.mask", false]], "mask() (scanspec.regions.rectangle method)": [[4, "scanspec.regions.Rectangle.mask", false]], "mask() (scanspec.regions.region method)": [[4, "scanspec.regions.Region.mask", false]], "mask() (scanspec.regions.symmetricdifferenceof method)": [[4, "scanspec.regions.SymmetricDifferenceOf.mask", false]], "mask() (scanspec.regions.unionof method)": [[4, "scanspec.regions.UnionOf.mask", false]], "max (scanspec.regions.range attribute)": [[4, "scanspec.regions.Range.max", false]], "midpoints (class in scanspec.core)": [[2, "scanspec.core.Midpoints", false]], "midpoints (scanspec.core.frames attribute)": [[2, "scanspec.core.Frames.midpoints", false]], "midpoints() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.midpoints", false]], "min (scanspec.regions.range attribute)": [[4, "scanspec.regions.Range.min", false]], "module": [[1, "module-scanspec", false], [2, "module-scanspec.core", false], [3, "module-scanspec.plot", false], [4, "module-scanspec.regions", false], [5, "module-scanspec.specs", false]], "num (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.num", false]], "num (scanspec.specs.repeat attribute)": [[5, "scanspec.specs.Repeat.num", false]], "num (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.num", false]], "num (scanspec.specs.static attribute)": [[5, "scanspec.specs.Static.num", false]], "otheraxis (class in scanspec.core)": [[2, "scanspec.core.OtherAxis", false]], "outer (scanspec.specs.product attribute)": [[5, "scanspec.specs.Product.outer", false]], "path (class in scanspec.core)": [[2, "scanspec.core.Path", false]], "plot_spec() (in module scanspec.plot)": [[3, "scanspec.plot.plot_spec", false]], "radius (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.radius", false]], "region (class in scanspec.regions)": [[4, "scanspec.regions.Region", false]], "region (scanspec.specs.mask attribute)": [[5, "scanspec.specs.Mask.region", false]], "right (scanspec.regions.combinationof attribute)": [[4, "scanspec.regions.CombinationOf.right", false]], "right (scanspec.regions.differenceof attribute)": [[4, "scanspec.regions.DifferenceOf.right", false]], "right (scanspec.regions.intersectionof attribute)": [[4, "scanspec.regions.IntersectionOf.right", false]], "right (scanspec.regions.symmetricdifferenceof attribute)": [[4, "scanspec.regions.SymmetricDifferenceOf.right", false]], "right (scanspec.regions.unionof attribute)": [[4, "scanspec.regions.UnionOf.right", false]], "right (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.right", false]], "right (scanspec.specs.zip attribute)": [[5, "scanspec.specs.Zip.right", false]], "rotate (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.rotate", false]], "scanspec": [[1, "module-scanspec", false]], "scanspec.core": [[2, "module-scanspec.core", false]], "scanspec.plot": [[3, "module-scanspec.plot", false]], "scanspec.regions": [[4, "module-scanspec.regions", false]], "scanspec.specs": [[5, "module-scanspec.specs", false]], "serialize() (scanspec.regions.region method)": [[4, "scanspec.regions.Region.serialize", false]], "serialize() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.serialize", false]], "shape() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.shape", false]], "snakedframes (class in scanspec.core)": [[2, "scanspec.core.SnakedFrames", false]], "spaced() (scanspec.specs.spiral method)": [[5, "scanspec.specs.Spiral.spaced", false]], "spec (class in scanspec.specs)": [[5, "scanspec.specs.Spec", false]], "spec (scanspec.specs.mask attribute)": [[5, "scanspec.specs.Mask.spec", false]], "spec (scanspec.specs.snake attribute)": [[5, "scanspec.specs.Snake.spec", false]], "spec (scanspec.specs.squash attribute)": [[5, "scanspec.specs.Squash.spec", false]], "squash_frames() (in module scanspec.core)": [[2, "scanspec.core.squash_frames", false]], "stack (scanspec.core.midpoints attribute)": [[2, "scanspec.core.Midpoints.stack", false]], "stack (scanspec.core.path attribute)": [[2, "scanspec.core.Path.stack", false]], "start (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.start", false]], "step() (in module scanspec.specs)": [[5, "scanspec.specs.step", false]], "stop (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.stop", false]], "strictconfig (in module scanspec.core)": [[2, "scanspec.core.StrictConfig", false]], "type (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.type", false]], "type (scanspec.regions.combinationof attribute)": [[4, "scanspec.regions.CombinationOf.type", false]], "type (scanspec.regions.differenceof attribute)": [[4, "scanspec.regions.DifferenceOf.type", false]], "type (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.type", false]], "type (scanspec.regions.intersectionof attribute)": [[4, "scanspec.regions.IntersectionOf.type", false]], "type (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.type", false]], "type (scanspec.regions.range attribute)": [[4, "scanspec.regions.Range.type", false]], "type (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.type", false]], "type (scanspec.regions.symmetricdifferenceof attribute)": [[4, "scanspec.regions.SymmetricDifferenceOf.type", false]], "type (scanspec.regions.unionof attribute)": [[4, "scanspec.regions.UnionOf.type", false]], "type (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.type", false]], "type (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.type", false]], "type (scanspec.specs.mask attribute)": [[5, "scanspec.specs.Mask.type", false]], "type (scanspec.specs.product attribute)": [[5, "scanspec.specs.Product.type", false]], "type (scanspec.specs.repeat attribute)": [[5, "scanspec.specs.Repeat.type", false]], "type (scanspec.specs.snake attribute)": [[5, "scanspec.specs.Snake.type", false]], "type (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.type", false]], "type (scanspec.specs.squash attribute)": [[5, "scanspec.specs.Squash.type", false]], "type (scanspec.specs.static attribute)": [[5, "scanspec.specs.Static.type", false]], "type (scanspec.specs.zip attribute)": [[5, "scanspec.specs.Zip.type", false]], "upper (scanspec.core.frames attribute)": [[2, "scanspec.core.Frames.upper", false]], "value (scanspec.specs.static attribute)": [[5, "scanspec.specs.Static.value", false]], "x_axis (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.x_axis", false]], "x_axis (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.x_axis", false]], "x_axis (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.x_axis", false]], "x_axis (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.x_axis", false]], "x_axis (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.x_axis", false]], "x_max (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.x_max", false]], "x_middle (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.x_middle", false]], "x_middle (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.x_middle", false]], "x_min (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.x_min", false]], "x_radius (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.x_radius", false]], "x_range (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.x_range", false]], "x_start (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.x_start", false]], "x_verts (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.x_verts", false]], "y_axis (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.y_axis", false]], "y_axis (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.y_axis", false]], "y_axis (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.y_axis", false]], "y_axis (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.y_axis", false]], "y_axis (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.y_axis", false]], "y_max (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.y_max", false]], "y_middle (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.y_middle", false]], "y_middle (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.y_middle", false]], "y_min (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.y_min", false]], "y_radius (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.y_radius", false]], "y_range (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.y_range", false]], "y_start (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.y_start", false]], "y_verts (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.y_verts", false]], "zip() (scanspec.core.frames method)": [[2, "scanspec.core.Frames.zip", false]], "zip() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.zip", false]]}, "objects": {"": [[21, 0, 1, "post--bounds", "/bounds"], [21, 0, 1, "post--gap", "/gap"], [21, 0, 1, "post--midpoints", "/midpoints"], [21, 0, 1, "post--smalleststep", "/smalleststep"], [21, 0, 1, "post--valid", "/valid"], [1, 1, 0, "-", "scanspec"]], "scanspec": [[1, 2, 1, "", "__version__"], [2, 1, 0, "-", "core"], [3, 1, 0, "-", "plot"], [4, 1, 0, "-", "regions"], [5, 1, 0, "-", "specs"]], "scanspec.core": [[2, 2, 1, "", "AxesPoints"], [2, 3, 1, "", "Axis"], [2, 3, 1, "", "Frames"], [2, 3, 1, "", "Midpoints"], [2, 3, 1, "", "OtherAxis"], [2, 3, 1, "", "Path"], [2, 3, 1, "", "SnakedFrames"], [2, 2, 1, "", "StrictConfig"], [2, 7, 1, "", "discriminated_union_of_subclasses"], [2, 7, 1, "", "gap_between_frames"], [2, 7, 1, "", "if_instance_do"], [2, 7, 1, "", "squash_frames"]], "scanspec.core.Frames": [[2, 4, 1, "", "axes"], [2, 4, 1, "", "concat"], [2, 4, 1, "", "extract"], [2, 5, 1, "", "gap"], [2, 5, 1, "", "lower"], [2, 5, 1, "", "midpoints"], [2, 5, 1, "", "upper"], [2, 4, 1, "", "zip"]], "scanspec.core.Midpoints": [[2, 6, 1, "", "axes"], [2, 5, 1, "", "stack"]], "scanspec.core.Path": [[2, 4, 1, "", "consume"], [2, 5, 1, "", "end_index"], [2, 5, 1, "", "index"], [2, 5, 1, "", "lengths"], [2, 5, 1, "", "stack"]], "scanspec.core.SnakedFrames": [[2, 4, 1, "", "extract"], [2, 4, 1, "", "from_frames"]], "scanspec.plot": [[3, 7, 1, "", "plot_spec"]], "scanspec.regions": [[4, 8, 1, "", "Circle"], [4, 8, 1, "", "CombinationOf"], [4, 8, 1, "", "DifferenceOf"], [4, 8, 1, "", "Ellipse"], [4, 8, 1, "", "IntersectionOf"], [4, 8, 1, "", "Polygon"], [4, 8, 1, "", "Range"], [4, 8, 1, "", "Rectangle"], [4, 3, 1, "", "Region"], [4, 8, 1, "", "SymmetricDifferenceOf"], [4, 8, 1, "", "UnionOf"], [4, 7, 1, "", "find_regions"], [4, 7, 1, "", "get_mask"]], "scanspec.regions.Circle": [[4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "radius"], [4, 9, 1, "", "type"], [4, 9, 1, "", "x_axis"], [4, 9, 1, "", "x_middle"], [4, 9, 1, "", "y_axis"], [4, 9, 1, "", "y_middle"]], "scanspec.regions.CombinationOf": [[4, 4, 1, "", "axis_sets"], [4, 9, 1, "", "left"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.regions.DifferenceOf": [[4, 9, 1, "", "left"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.regions.Ellipse": [[4, 9, 1, "", "angle"], [4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "type"], [4, 9, 1, "", "x_axis"], [4, 9, 1, "", "x_middle"], [4, 9, 1, "", "x_radius"], [4, 9, 1, "", "y_axis"], [4, 9, 1, "", "y_middle"], [4, 9, 1, "", "y_radius"]], "scanspec.regions.IntersectionOf": [[4, 9, 1, "", "left"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.regions.Polygon": [[4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "type"], [4, 9, 1, "", "x_axis"], [4, 9, 1, "", "x_verts"], [4, 9, 1, "", "y_axis"], [4, 9, 1, "", "y_verts"]], "scanspec.regions.Range": [[4, 9, 1, "", "axis"], [4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "max"], [4, 9, 1, "", "min"], [4, 9, 1, "", "type"]], "scanspec.regions.Rectangle": [[4, 9, 1, "", "angle"], [4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "type"], [4, 9, 1, "", "x_axis"], [4, 9, 1, "", "x_max"], [4, 9, 1, "", "x_min"], [4, 9, 1, "", "y_axis"], [4, 9, 1, "", "y_max"], [4, 9, 1, "", "y_min"]], "scanspec.regions.Region": [[4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "deserialize"], [4, 4, 1, "", "mask"], [4, 4, 1, "", "serialize"]], "scanspec.regions.SymmetricDifferenceOf": [[4, 9, 1, "", "left"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.regions.UnionOf": [[4, 9, 1, "", "left"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.specs": [[5, 8, 1, "", "Concat"], [5, 2, 1, "", "DURATION"], [5, 8, 1, "", "Line"], [5, 8, 1, "", "Mask"], [5, 8, 1, "", "Product"], [5, 8, 1, "", "Repeat"], [5, 8, 1, "", "Snake"], [5, 3, 1, "", "Spec"], [5, 8, 1, "", "Spiral"], [5, 8, 1, "", "Squash"], [5, 8, 1, "", "Static"], [5, 8, 1, "", "Zip"], [5, 7, 1, "", "fly"], [5, 7, 1, "", "step"]], "scanspec.specs.Concat": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "check_path_changes"], [5, 9, 1, "", "gap"], [5, 9, 1, "", "left"], [5, 9, 1, "", "right"], [5, 9, 1, "", "type"]], "scanspec.specs.Line": [[5, 4, 1, "", "axes"], [5, 9, 1, "", "axis"], [5, 4, 1, "", "bounded"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "num"], [5, 9, 1, "", "start"], [5, 9, 1, "", "stop"], [5, 9, 1, "", "type"]], "scanspec.specs.Mask": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "check_path_changes"], [5, 9, 1, "", "region"], [5, 9, 1, "", "spec"], [5, 9, 1, "", "type"]], "scanspec.specs.Product": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "inner"], [5, 9, 1, "", "outer"], [5, 9, 1, "", "type"]], "scanspec.specs.Repeat": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "gap"], [5, 9, 1, "", "num"], [5, 9, 1, "", "type"]], "scanspec.specs.Snake": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "spec"], [5, 9, 1, "", "type"]], "scanspec.specs.Spec": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 4, 1, "", "concat"], [5, 4, 1, "", "deserialize"], [5, 4, 1, "", "frames"], [5, 4, 1, "", "midpoints"], [5, 4, 1, "", "serialize"], [5, 4, 1, "", "shape"], [5, 4, 1, "", "zip"]], "scanspec.specs.Spiral": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "num"], [5, 9, 1, "", "rotate"], [5, 4, 1, "", "spaced"], [5, 9, 1, "", "type"], [5, 9, 1, "", "x_axis"], [5, 9, 1, "", "x_range"], [5, 9, 1, "", "x_start"], [5, 9, 1, "", "y_axis"], [5, 9, 1, "", "y_range"], [5, 9, 1, "", "y_start"]], "scanspec.specs.Squash": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "check_path_changes"], [5, 9, 1, "", "spec"], [5, 9, 1, "", "type"]], "scanspec.specs.Static": [[5, 4, 1, "", "axes"], [5, 9, 1, "", "axis"], [5, 4, 1, "", "calculate"], [5, 4, 1, "", "duration"], [5, 9, 1, "", "num"], [5, 9, 1, "", "type"], [5, 9, 1, "", "value"]], "scanspec.specs.Zip": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "left"], [5, 9, 1, "", "right"], [5, 9, 1, "", "type"]]}, "objnames": {"0": ["http", "post", "HTTP post"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "method", "Python method"], "5": ["py", "attribute", "Python attribute"], "6": ["py", "property", "Python property"], "7": ["py", "function", "Python function"], "8": ["py", "pydantic_model", "Python model"], "9": ["py", "pydantic_field", "Python field"]}, "objtypes": {"0": "http:post", "1": "py:module", "2": "py:data", "3": "py:class", "4": "py:method", "5": "py:attribute", "6": "py:property", "7": "py:function", "8": "py:pydantic_model", "9": "py:pydantic_field"}, "terms": {"": [7, 8, 15], "0": [2, 3, 4, 5, 11, 12, 16, 18, 19, 21, 23, 25], "000000000000002": 25, "1": [2, 3, 4, 5, 7, 11, 12, 16, 18, 19, 23], "10": [2, 3, 4, 5, 19, 24, 25], "100": [12, 15], "100x2000x2000": 12, "1024": 25, "12": [5, 19, 25], "13": 2, "15": 10, "18": 12, "1818181818181817": 19, "1d": [10, 23], "2": [2, 3, 4, 5, 7, 12, 16, 18, 19], "200": [3, 21], "2000": 12, "25": 16, "2d": [3, 19], "2gb": 12, "3": [2, 3, 4, 5, 11, 12, 16, 18, 19, 23, 24, 25], "30": [4, 5, 19], "32": 12, "333333333333333": 25, "4": [2, 4, 5, 12, 18, 19, 23, 25], "422": [21, 25], "44": 19, "5": [2, 4, 5, 10, 12, 16, 18, 19, 23, 25], "50": 5, "6": [2, 4, 5, 12, 18, 23, 25], "666666666666667": 25, "7": 2, "7222222222222222": 19, "75": [4, 5, 16], "8": [4, 5, 12, 19], "8080": 25, "8333333333333333": 19, "8kb": 12, "9": [3, 4, 5], "A": [2, 4, 5, 10, 11, 12, 16, 21], "As": [7, 9], "For": [2, 7, 11, 12, 15, 16, 23], "If": [2, 3, 4, 5, 10, 11, 12, 15, 23, 24], "In": [10, 16, 25], "It": [2, 5, 15, 19, 24], "On": 16, "The": [2, 4, 5, 9, 11, 12, 21, 23, 24, 25], "There": [5, 25], "These": [2, 23], "To": [8, 16, 17, 23, 25], "Will": 5, "__version__": 1, "_stack_": 10, "abc": 2, "abl": 11, "abov": [2, 8, 10, 11, 12, 23], "absolut": 21, "abstract": [4, 5], "abstractmethod": 2, "accept": [8, 9, 25], "access": 19, "activ": [10, 24], "actual": [2, 12], "ad": [2, 23], "add": 2, "additionalproperti": [4, 5], "adopt": 7, "adr": [7, 8], "advis": 12, "after": [2, 5, 11, 21], "alia": 2, "all": [2, 4, 5, 12, 15], "allow": [11, 25], "along": [2, 4, 5, 10, 12], "alreadi": 17, "also": [5, 15, 16, 19, 24], "altern": 2, "alwai": 11, "an": [2, 4, 5, 10, 11, 18, 19, 21, 23], "angl": [4, 5], "ani": [2, 3, 4, 5, 12, 15, 21, 24], "annot": 5, "anoth": [5, 10, 11], "apart": 11, "api": [1, 19, 20, 25], "appear": 5, "appli": 23, "applic": 25, "ar": [2, 3, 4, 5, 7, 10, 11, 12, 15, 16, 17, 19, 21, 23, 25], "archimedean": 5, "architectur": [6, 19], "arg": 21, "argument": 2, "arrai": [2, 4, 5, 10, 12, 16, 21], "arrow": [5, 23], "arrowhead": 23, "articl": 8, "ask": 15, "assert": [2, 5], "attribut": 16, "avail": [10, 17], "avoid": 5, "ax": [2, 4, 5, 10, 19], "axespoint": 2, "axi": [2, 4, 5, 12, 16, 18, 21, 25], "axis_set": 4, "b": [4, 5], "back": [16, 18], "bar": 19, "baseclass": [4, 5], "basemodel": 2, "becaus": 25, "been": 24, "befor": 15, "below": [7, 11, 21], "better": 2, "between": [2, 5, 11, 21, 23], "big": 15, "bin": 24, "bind": 2, "black": [3, 23], "blog": 7, "blueski": [17, 19, 24], "bool": [2, 4, 5], "boolean": 5, "both": [2, 4, 5, 21], "bound": [2, 5, 16, 19, 21, 23], "boundsrespons": 21, "bracket": 5, "bring": 25, "browser": 25, "bug": 15, "built": 17, "c": [2, 25], "calcul": [1, 2, 5, 10, 12, 16, 19, 21], "calculate_gap": 2, "callabl": 2, "can": [2, 4, 5, 6, 9, 10, 12, 15, 16, 18, 19, 21, 23, 24, 25], "canon": 21, "case": 11, "categori": 19, "caught": 15, "caus": 12, "cd": 9, "centr": [5, 23], "central": [4, 5], "chang": [2, 5, 6, 9, 12, 15, 19], "check": [2, 5, 15, 16], "check_path_chang": [2, 5, 11], "children": 4, "chunk": [2, 16, 19], "ci": 9, "circl": [3, 4, 5, 12, 19, 23], "cl": 2, "class": [2, 4, 5], "classmethod": 2, "client": [23, 25], "clockwis": [4, 5], "close": 15, "code": [2, 3, 4, 5, 11, 21, 23, 25], "colour": [3, 10, 23], "com": 24, "combin": [4, 5, 19, 23], "combinationof": [4, 5], "command": 25, "commandlin": [24, 25], "commit": 15, "common": 15, "compact": 12, "compar": 11, "compat": 25, "complex": 23, "compos": 19, "concat": [2, 5, 19], "concaten": [2, 5], "conduct": 16, "configdict": 2, "configur": 15, "consecut": 5, "consid": [10, 11, 12], "consist": 9, "const": [4, 5], "constraint": [4, 5], "consum": [2, 10, 16, 19], "contain": [4, 5, 10, 12, 14, 15, 16, 19], "container": 15, "content": 25, "continu": 5, "contribut": [14, 19], "conveni": [2, 19], "coordin": [4, 5, 25], "copi": 8, "copier": [7, 15], "cor": 25, "core": [4, 5, 16, 19], "correspond": 21, "could": [9, 11, 16, 23], "covari": 2, "creat": [2, 4, 5, 6, 8, 10, 11, 15, 16, 19, 22, 25], "cross": 23, "ctrl": 25, "cube": 3, "curl": 25, "current": 24, "cycler": 19, "d": [16, 25], "data": [11, 12], "dataclass": 2, "decis": [6, 19], "decor": 2, "def": [2, 4, 5], "default": [2, 4, 5], "defin": [2, 23], "degre": [4, 5], "demand": 11, "demonstr": 23, "denot": 10, "depend": [12, 17, 24], "describ": [2, 8, 10], "descript": [4, 5, 21], "deseri": [2, 4, 5, 14, 19, 23], "destroi": 12, "detail": 12, "detector": [10, 11], "determin": 2, "devcontain": 15, "develop": 9, "diagram": 10, "diamond": 15, "dict": [2, 4], "dictionari": [2, 4, 5, 16, 18], "differ": [2, 3, 5, 9, 10], "differenceof": [4, 5, 23], "dimens": 5, "dimension": [11, 12, 19], "direct": 11, "directli": 19, "discrimin": [2, 4, 5], "discriminated_union_of_subclass": 2, "disjoint": 23, "disk": 12, "do": [5, 23, 24, 25], "doc": 25, "docker": [17, 19], "document": [2, 10, 21], "doe": 15, "don": 15, "dot": 23, "down": 5, "dr": 5, "draw": [3, 10], "dtype": [2, 4], "durat": [5, 10, 19], "dure": 2, "e": [2, 10, 21], "each": [2, 3, 5, 10, 11, 12, 16, 19, 21, 23, 25], "earlier": 5, "easili": 15, "editor": 25, "effici": 19, "either": [2, 4, 5], "element": 2, "ellips": [4, 5], "empti": 5, "end": [2, 5, 15, 23], "end_index": 2, "endpoint": [21, 25], "enough": 16, "ensur": [2, 9, 25], "enter": 23, "entir": 16, "entireti": 5, "entiti": 21, "enum": [4, 5], "environ": [9, 15], "equal": 5, "error": [2, 21, 25], "evalu": 23, "even": 11, "everi": [5, 11], "exampl": [2, 3, 4, 5, 11, 16, 18, 19, 23, 25], "example_spec": [4, 5], "exclud": 5, "exclusiveminimum": [4, 5], "execut": [5, 12, 16], "exist": [8, 15, 24], "expand": [5, 19], "experienc": [14, 19], "explan": 19, "explicitli": 11, "expos": 25, "express": 2, "extend": 2, "extra": [2, 24], "extract": 2, "extrem": 5, "fail": 11, "fall": 5, "fals": [2, 4, 5, 11, 16], "faster": [2, 12], "fastest": [2, 5, 12], "featur": 24, "few": 16, "field": [2, 4, 5], "fieldinfo": 5, "file": 15, "fill": 3, "final": 5, "find_region": 4, "first": [2, 4, 5, 11, 12, 16, 23], "fit": [15, 16], "fix": [5, 9, 10], "flag": 11, "float": [2, 4, 5], "float64": [12, 16], "float_list": 25, "fly": [2, 5, 10, 12, 19], "flyscan": [5, 19], "follow": [9, 23], "forbid": 2, "forc": [2, 5], "form": [2, 5, 12], "format": [9, 21, 25], "forth": 16, "four": 19, "frame": [2, 3, 5, 6, 16, 19, 21, 23], "frames1": 2, "frames2": 2, "free": 15, "from": [2, 3, 4, 5, 8, 9, 10, 11, 12, 16, 17, 18, 19, 21, 24], "from_fram": 2, "func": 2, "function": 23, "fx": 2, "fy": 2, "g": 2, "gap": [2, 5, 21], "gap_between_fram": 2, "gaprespons": 21, "ge": 5, "gener": [19, 21, 22, 24], "get": [16, 17, 23], "get_mask": 4, "ghcr": [17, 19], "git": 24, "github": [15, 17, 19, 24], "give": [12, 16, 25], "given": [2, 4, 5, 10, 19, 23], "graph": 23, "great": 15, "grei": [3, 23], "grid": [4, 5, 10, 12, 16, 19], "gt": 4, "guarante": 23, "gui": 25, "guid": [15, 19], "h": 25, "ha": [18, 23, 24], "had": 11, "hand": [4, 5], "handl": [2, 15], "have": [2, 5, 9, 12, 15, 16], "hdf": 12, "height": 5, "helper": 2, "here": [19, 22, 23], "hire": [3, 4, 5, 11, 23], "hold": 12, "hook": 15, "how": [2, 5, 6, 15, 23, 25], "howev": 12, "http": [19, 24, 25], "i": [2, 3, 4, 5, 10, 11, 12, 15, 21, 23, 24, 25], "idea": 15, "identifi": [2, 5], "if_instance_do": 2, "ignor": 21, "illustr": 11, "imag": 12, "imagin": 12, "implement": 2, "import": [3, 4, 5, 11, 12, 16, 18, 19, 23], "improv": 15, "includ": [19, 20, 23], "inclus": [4, 5], "increas": 23, "index": [2, 19, 20], "indic": [2, 5, 21, 23], "individu": 5, "info": 21, "inform": [7, 12, 16], "inherit": 2, "inner": [5, 12, 18, 23, 25], "input": [2, 23], "insert": [2, 16], "insid": [4, 5, 19], "inspect": 25, "instal": [17, 19, 22], "instanc": 16, "instanti": 18, "instead": [2, 5, 15, 17], "int": [2, 5], "int64": 2, "integ": 5, "inter": 10, "interact": 23, "interfac": 24, "interfer": 24, "intermedi": 16, "interpret": [2, 12], "intersectionof": [4, 5, 23], "intliter": 2, "invalid": 11, "invari": 11, "involv": 15, "io": [17, 19], "item": [4, 5], "iter": [2, 4, 5, 11, 12, 14, 19, 23], "its": [2, 4, 5, 12, 15, 17, 18, 24], "itself": 12, "join": 5, "json": [2, 4, 5, 25], "jump": 11, "just": 12, "keep": [7, 11, 16], "kei": 5, "l1": 5, "l2": 5, "last": [2, 5, 16, 23], "later": [5, 24], "latest": [9, 17, 19], "left": [2, 4, 5], "len": [2, 5, 12, 16, 19], "length": [2, 10, 19], "less": 3, "let": [12, 18], "level": 1, "librari": 15, "lifetim": 7, "light": 15, "like": [2, 12, 15, 19, 23, 25], "line": [3, 4, 5, 10, 11, 12, 16, 18, 19, 25], "linear": 2, "linearli": 5, "link": [8, 19], "lint": 9, "list": [2, 4, 5, 7, 10, 11, 12], "liter": [4, 5], "ll": 23, "localhost": 25, "locat": 10, "long": [5, 12], "look": [2, 19], "lower": [2, 5, 10, 12, 16, 21, 23], "m": 24, "machin": 16, "made": [7, 8, 10], "mai": [2, 9, 11, 16, 21, 23], "make": [11, 12, 15, 23], "manag": 9, "mani": [5, 16], "map": [2, 4, 5, 25], "mark": [3, 23], "mask": [2, 4, 5, 6, 12, 19], "match": [4, 5], "materi": [19, 20], "max": [4, 5], "max_fram": 25, "maximum": [4, 5, 16, 21], "mean": [2, 5, 11, 12], "member": [2, 3, 4, 5], "memori": [12, 16], "merg": [2, 5, 11], "metadata": 5, "method": 16, "michael": [7, 8], "middl": [4, 5, 21, 25], "midpoint": [2, 3, 4, 5, 10, 12, 19, 21, 23], "midpointsrespons": 21, "might": [15, 23], "min": [4, 5], "min_length": 4, "minimum": [4, 5, 21], "minitem": [4, 5], "miss": 25, "model": [4, 5], "modifi": 5, "modul": 9, "modulo": 2, "more": [2, 7, 11, 14, 15, 19], "most": [2, 12, 15, 25], "motion": [5, 23], "motor": [10, 11, 16], "move": [2, 5, 11, 12, 16], "mp": 2, "much": 5, "multidimension": 10, "multipl": [5, 19], "must": [2, 5, 11], "my_sum": 2, "n": [4, 5], "name": [2, 4, 5, 25], "narrai": [4, 5], "ncan": 5, "ncombin": 5, "ndarrai": [2, 4, 19], "neach": 5, "necessarili": 2, "need": [2, 5, 8, 11, 12, 15, 24], "neg": 11, "nest": [2, 5, 11, 12], "new": [2, 8, 15, 16, 19, 22], "next": 2, "nform": 5, "nice": 25, "nif": 5, "non": [4, 11, 12], "none": [2, 3], "note": [5, 19, 20], "notimpl": 2, "now": [24, 25], "np": [2, 4, 5, 16], "nproduc": 5, "nsee": 5, "nstack": 5, "nstart": 5, "nthi": 5, "ntypic": [4, 5], "num": [2, 5, 16, 18, 19, 25], "number": [1, 2, 4, 5, 10, 11, 12, 15, 17], "numpi": 16, "nx1": [4, 5], "nygard": [7, 8], "obj": [4, 5], "object": [2, 4, 5, 10, 11, 12, 16], "obviou": 15, "offer": 15, "ok": 21, "onc": [2, 5, 11, 12, 16], "one": [2, 4, 5, 11, 15, 16, 23], "oneof": [4, 5], "ones": [4, 8], "onli": [5, 11, 23], "open": [15, 25], "openapi": 25, "oper": [2, 4, 5, 23], "operand": 5, "option": 19, "order": [2, 5, 11], "organis": 25, "origin": 11, "other": [2, 5, 11], "otheraxi": [2, 5], "otherwis": [2, 4, 11, 21], "our": [12, 23], "out": [12, 16], "outer": [5, 12, 18, 25], "output": [2, 5, 23, 25], "outsid": 5, "over": [12, 19], "overlap": 4, "overload": 2, "own": 15, "p": 2, "packag": 9, "page": [10, 11], "parallel": 5, "param": 2, "paramet": [2, 5, 12, 18, 25], "parse_obj_a": 2, "part": 2, "particularli": 16, "pass": [2, 11, 25], "past": [2, 8], "path": [2, 3, 5, 6, 12, 16, 19, 23, 24], "pdf": [3, 4, 5, 11, 23], "per": [2, 12, 21], "perform": [2, 12, 19], "period": 12, "pick": 12, "pip": [9, 19, 24], "place": 15, "pleas": 15, "plot": [4, 5, 11, 19, 24, 25], "plot_spec": [3, 4, 5, 11, 23], "png": [3, 4, 5, 11, 23], "point": [2, 4, 5, 12, 19, 21, 22, 24], "polygon": [4, 5], "posit": [2, 12, 19], "possibli": 10, "post": [21, 25], "potenti": 11, "practic": [14, 19], "pre": [15, 17], "present": [2, 4, 5], "press": 25, "previou": [2, 16], "print": [2, 16, 19], "produc": [2, 4, 5, 10, 11, 16, 19, 21], "product": [5, 12, 18, 19, 23, 25], "program": 23, "project": [7, 8, 14, 19], "properti": [2, 4, 5], "propertynam": [4, 5], "provid": 2, "pull": [9, 15, 17], "push": 5, "pydant": [2, 4, 5], "pypa": 1, "pypi": 19, "python": [7, 15, 19, 23], "python3": 24, "question": 15, "quickli": 23, "quit": 25, "r": [4, 5], "r1": 5, "radiu": [4, 5, 19], "rais": 15, "ram": 12, "rang": [4, 5], "rather": 19, "raw": 2, "read": 23, "reader": 12, "reason": [12, 16], "recalcul": 2, "recommend": [15, 24], "reconstruct": 19, "record": [6, 19], "rectangl": [4, 5], "recurs": [4, 18], "reduc": 15, "ref": [4, 5], "refer": [10, 12, 19], "region": [3, 5, 19], "registri": 17, "regular": 12, "releas": [17, 19, 20, 24], "remain": 15, "reorder": 2, "repeat": [5, 10, 11], "repetit": 2, "repositori": 15, "repr": 18, "repres": 2, "represent": [5, 12], "request": [15, 21, 25], "requir": [2, 4, 5, 12, 24], "reshap": [11, 12], "respons": 21, "rest": [19, 20, 22, 24], "restrict": [2, 5, 19], "result": [11, 23], "return": [2, 4, 5, 10, 21, 25], "returned_fram": 25, "revers": [2, 5, 11], "right": [2, 4, 5], "ring": 5, "rotat": [4, 5], "rout": [2, 10], "row": 16, "run": [2, 5, 11, 14, 15, 16, 19, 22, 24], "sai": 16, "same": [2, 5, 12, 15, 19], "save": 12, "scan": [2, 3, 5, 10, 11, 12, 19, 21, 22, 25], "scanspec": [11, 12, 16, 17, 18, 21, 23, 24, 25], "schema": [2, 4, 5], "scope": 15, "second": [4, 5, 11, 12], "section": 10, "see": [5, 7, 8, 12, 15, 16, 21, 23, 25], "segment": 16, "self": 2, "send": [23, 25], "sens": 12, "seri": [2, 10], "serial": [2, 4, 5, 14, 19, 23], "serializ": [5, 19], "server": 19, "servic": [19, 21, 22, 24], "set": [4, 5, 9, 11, 15, 21, 23], "setpoint": 12, "setup": 9, "setuptools_scm": 1, "sever": 25, "shape": 5, "share": [2, 15], "shot": 16, "should": [2, 5, 9, 10, 12, 16, 23, 24, 25], "show": [4, 5, 18, 23, 25], "shown": 3, "signedinteg": 2, "significantli": 15, "simpl": [16, 23], "simplest": 12, "simpli": 12, "simplifi": 5, "singl": [2, 5, 10, 12, 16], "size": [5, 12, 16, 21], "slower": [2, 11, 12], "slowest": [2, 5, 11, 12], "small": 16, "smallest": 21, "smalleststep": 21, "smalleststeprespons": 21, "snake": [2, 5, 10, 12, 16, 19], "snakedfram": 2, "so": [2, 11, 12, 16, 24], "softwar": 24, "some": [10, 11, 12, 23], "someth": [15, 16], "sourc": [2, 3, 4, 5, 11, 15, 19, 23, 24], "space": [5, 10], "span": [4, 5], "spec": [2, 3, 4, 10, 11, 12, 14, 19, 21, 22], "special": 5, "specif": [5, 16], "specifi": [2, 5, 12, 19], "spend": [5, 15, 19], "spiral": [5, 19], "split": 19, "squash": [2, 5, 6, 19], "squash_fram": 2, "stack": [2, 5, 6, 11, 16, 19], "start": [2, 5, 16, 18, 19, 22, 23, 25], "static": [4, 5], "statu": 21, "step": [5, 14, 16, 19, 21], "stop": [5, 12, 18, 25], "str": [1, 2, 3, 4, 5, 21], "strategi": [11, 12], "strictconfig": 2, "stride": 11, "string": [4, 5], "structur": 7, "subclass": [2, 4, 5], "submodul": 1, "subset": 16, "subtract": 2, "success": 21, "suit": 15, "super_cl": 2, "superclass": 2, "suppli": 2, "support": [4, 5, 11], "sure": 15, "surpris": 11, "swagger": 25, "switch": 9, "symmetricdifferenceof": [4, 5, 23], "system": 23, "t": [2, 12, 15], "take": [11, 12, 16], "taken": [3, 10, 23], "tandem": 5, "task": 15, "technic": [2, 6, 19, 20], "techniqu": 9, "tell": 12, "templat": [7, 15], "term": [2, 6, 19], "termin": [23, 24, 25], "test": 15, "than": [2, 3, 11, 19], "thei": [5, 10, 11, 12], "them": [3, 5, 16, 19, 23], "thi": [2, 4, 5, 7, 8, 9, 10, 15, 16, 18, 23, 24, 25], "those": 25, "three": 10, "through": [2, 3, 5, 10, 11, 15, 16, 19], "throughout": [7, 10], "ticket": 15, "time": [5, 11, 12, 15], "titl": [3, 4, 5], "togeth": [5, 10, 11, 12], "tool": 9, "top": [1, 19], "total_fram": 25, "track": 7, "trajectori": 10, "travers": [2, 12], "true": [2, 4, 5, 16], "tupl": 5, "turn": [12, 18], "turnaround": [3, 5, 16, 23], "tutori": [19, 23, 25], "two": [2, 4, 5, 10, 11, 12, 21, 23], "type": [2, 4, 5, 18, 23, 24, 25], "typevar": 2, "typic": [2, 4, 5, 19, 22], "ui": 25, "unfortun": 11, "union": 2, "unionof": [4, 5, 23], "unpack": 16, "unprocess": 21, "unsquash": 11, "until": 12, "up": [2, 10, 15, 25], "updat": [2, 9], "upper": [2, 5, 10, 12, 16, 19, 21, 23], "us": [2, 3, 5, 8, 9, 10, 12, 15, 16, 17, 18, 19, 23, 24, 25], "usag": [19, 22], "user": [11, 14, 19, 22], "util": 25, "valid": 21, "validrespons": 21, "valu": [2, 4, 5], "valueerror": 11, "variabl": [2, 23], "vd": [11, 12], "vector": 10, "venv": [9, 24], "veri": 16, "version": [1, 2, 11, 17, 21], "vert": [4, 5], "vertic": [4, 5], "viabl": 21, "view": 16, "visual": 3, "vscode": 15, "wa": [10, 15, 18], "wai": [2, 6, 7, 16, 19], "want": [5, 15, 23, 25], "we": [7, 8, 9, 11, 12, 15, 16, 18, 23, 25], "web": 25, "welcom": 15, "wether": 21, "what": [5, 23], "when": [2, 5, 11, 12, 15, 16, 19], "where": [2, 11, 16, 23], "whether": [2, 21], "which": [2, 4, 11, 12, 19, 25], "while": [10, 15], "whole": 10, "why": [2, 5, 6, 10, 16, 19], "width": 5, "within": [2, 4, 5, 10, 11, 23], "won": 12, "work": [6, 16, 19], "would": [10, 11, 12, 23, 25], "wrap": 5, "wrapper": 16, "write": [11, 12], "written": 12, "x": [2, 3, 4, 5, 10, 11, 12, 16, 18, 19, 23, 25], "x_axi": [4, 5], "x_max": [4, 5], "x_middl": [4, 5], "x_min": [4, 5], "x_radiu": [4, 5], "x_rang": 5, "x_start": 5, "x_vert": [4, 5], "xmotor": 2, "xy": [4, 5], "y": [2, 3, 4, 5, 11, 12, 16, 18, 19, 23, 25], "y_axi": [4, 5], "y_max": [4, 5], "y_middl": [4, 5], "y_min": [4, 5], "y_radiu": [4, 5], "y_rang": 5, "y_start": 5, "y_vert": [4, 5], "yield": 4, "ymotor": 2, "you": [5, 12, 15, 23, 24, 25], "your": 15, "z": [3, 5, 11, 23], "zip": [2, 5, 19, 23]}, "titles": ["API", "scanspec", "scanspec.core", "scanspec.plot", "scanspec.regions", "scanspec.specs", "Explanations", "Architectural Decision Records", "1. Record architecture decisions", "2. Adopt python-copier-template for project structure", "Technical Terms", "Why Squash (and Mask) can change the Path", "Why create a stack of Frames?", "Index", "How-to Guides", "Contribute to the project", "How to Iterate a Spec", "Run in a container", "How to Serialize and Deserialize a Spec", "scanspec", "Reference", "REST API", "Tutorials", "Creating a Scan Spec", "Installation", "Running a REST service for generating points"], "titleterms": {"1": 8, "2": [9, 23], "If": 16, "about": 12, "adopt": 9, "an": 12, "api": [0, 21], "architectur": [7, 8], "ax": 23, "axi": [10, 11], "between": 16, "can": 11, "chang": 11, "check": 24, "code": 15, "commandlin": 23, "conclus": 23, "consequ": [8, 9], "contain": 17, "context": [8, 9], "contribut": 15, "copier": 9, "core": 2, "coverag": 15, "creat": [12, 23, 24], "decis": [7, 8, 9], "deseri": 18, "develop": 15, "dimens": 12, "discuss": 15, "do": 16, "document": 19, "doe": 12, "environ": 24, "exampl": 12, "explan": 6, "flat": 12, "fly": 16, "frame": [10, 11, 12], "from": 23, "gap": 16, "gener": 25, "grid": 23, "guid": 14, "hdf5": 12, "how": [12, 14, 16, 18, 19], "i": [16, 19], "index": 13, "inform": 15, "instal": 24, "issu": 15, "iter": 16, "know": 16, "length": 11, "librari": 24, "line": 23, "mask": [11, 23], "matter": 11, "midpoint": [16, 25], "most": 16, "multipl": 23, "need": 16, "odd": 11, "onli": 16, "option": 16, "path": [10, 11], "perform": 16, "plot": [3, 23], "point": [10, 16, 25], "project": [9, 15], "python": [9, 24], "record": [7, 8], "refer": 20, "region": [4, 12, 23], "relat": 12, "rest": [21, 25], "run": [17, 25], "scan": [16, 23], "scanspec": [1, 2, 3, 4, 5, 19], "sequenc": 12, "serial": 18, "server": 25, "servic": 25, "snake": [11, 23], "spec": [5, 16, 18, 23, 25], "squash": [11, 12], "stack": [10, 12], "start": 17, "statu": [8, 9], "structur": [9, 19], "technic": 10, "templat": 9, "term": 10, "them": 12, "thi": [11, 12], "tutori": 22, "unsnak": 11, "valid": 25, "version": 24, "virtual": 24, "want": 16, "what": 12, "whether": 16, "why": [11, 12], "you": 16, "your": 24}}) \ No newline at end of file +Search.setIndex({"alltitles": {"1. Record architecture decisions": [[8, null]], "2. Adopt python-copier-template for project structure": [[9, null]], "API": [[0, null]], "An Example": [[12, "an-example"]], "Architectural Decision Records": [[7, null]], "Axis": [[10, "axis"]], "Check your version of python": [[24, "check-your-version-of-python"]], "Code Coverage": [[15, "code-coverage"]], "Conclusion": [[23, "conclusion"]], "Consequences": [[8, "consequences"], [9, "consequences"]], "Context": [[8, "context"], [9, "context"]], "Contribute to the project": [[15, null]], "Create a virtual environment": [[24, "create-a-virtual-environment"]], "Creating a Scan Spec": [[23, null]], "Decision": [[8, "decision"], [9, "decision"]], "Developer Information": [[15, "developer-information"]], "Explanations": [[6, null]], "Frame": [[10, "frame"]], "Generating Midpoints": [[25, "generating-midpoints"]], "Grid": [[23, "grid"]], "How does this stack relate to HDF5 Dimensions?": [[12, "how-does-this-stack-relate-to-hdf5-dimensions"]], "How the documentation is structured": [[19, "how-the-documentation-is-structured"]], "How to Deserialize": [[18, "how-to-deserialize"]], "How to Iterate a Spec": [[16, null]], "How to Serialize": [[18, "how-to-serialize"]], "How to Serialize and Deserialize a Spec": [[18, null]], "How-to Guides": [[14, null]], "If you need to do a fly scan": [[16, "if-you-need-to-do-a-fly-scan"]], "If you need to know whether there is a gap between points": [[16, "if-you-need-to-know-whether-there-is-a-gap-between-points"]], "If you only need the midpoints": [[16, "if-you-only-need-the-midpoints"]], "If you want the most performant option": [[16, "if-you-want-the-most-performant-option"]], "Index": [[13, null]], "Installation": [[24, null]], "Installing the library": [[24, "installing-the-library"]], "Issue or Discussion?": [[15, "issue-or-discussion"]], "Line": [[23, "line"]], "Line with 2 axes": [[23, "line-with-2-axes"]], "Masking with Multiple Regions": [[23, "masking-with-multiple-regions"]], "Masking with Regions": [[23, "masking-with-regions"]], "Path": [[10, "path"]], "Plotting from the commandline": [[23, "plotting-from-the-commandline"]], "Point": [[10, "point"]], "REST API": [[21, null]], "Reference": [[20, null]], "Run in a container": [[17, null]], "Running a REST service for generating points": [[25, null]], "Running the server": [[25, "running-the-server"]], "Snaked Grid": [[23, "snaked-grid"]], "Squash snaked axis into unsnaked odd length axis": [[11, "squash-snaked-axis-into-unsnaked-odd-length-axis"]], "Squash unsnaked axis into a snaked Frames": [[11, "squash-unsnaked-axis-into-a-snaked-frames"]], "Stack of Frames": [[10, "stack-of-frames"]], "Starting the container": [[17, "starting-the-container"]], "Status": [[8, "status"], [9, "status"]], "Technical Terms": [[10, null]], "Tutorials": [[22, null]], "Validating a Spec": [[25, "validating-a-spec"]], "What about Regions?": [[12, "what-about-regions"]], "Why Squash (and Mask) can change the Path": [[11, null]], "Why create a stack of Frames?": [[12, null]], "Why not squash them into a flat sequence?": [[12, "why-not-squash-them-into-a-flat-sequence"]], "Why this matters": [[11, "why-this-matters"]], "scanspec": [[1, null], [19, null]], "scanspec.core": [[2, null]], "scanspec.plot": [[3, null]], "scanspec.regions": [[4, null]], "scanspec.specs": [[5, null]]}, "docnames": ["_api", "_api/scanspec", "_api/scanspec.core", "_api/scanspec.plot", "_api/scanspec.regions", "_api/scanspec.specs", "explanations", "explanations/decisions", "explanations/decisions/0001-record-architecture-decisions", "explanations/decisions/0002-switched-to-python-copier-template", "explanations/technical-terms", "explanations/why-squash-can-change-path", "explanations/why-stack-frames", "genindex", "how-to", "how-to/contribute", "how-to/iterate-a-spec", "how-to/run-container", "how-to/serialize-a-spec", "index", "reference", "reference/rest_api", "tutorials", "tutorials/creating-a-spec", "tutorials/installation", "tutorials/rest-service"], "envversion": {"sphinx": 64, "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}, "filenames": ["_api.rst", "_api/scanspec.rst", "_api/scanspec.core.rst", "_api/scanspec.plot.rst", "_api/scanspec.regions.rst", "_api/scanspec.specs.rst", "explanations.md", "explanations/decisions.md", "explanations/decisions/0001-record-architecture-decisions.md", "explanations/decisions/0002-switched-to-python-copier-template.md", "explanations/technical-terms.rst", "explanations/why-squash-can-change-path.rst", "explanations/why-stack-frames.rst", "genindex.md", "how-to.md", "how-to/contribute.md", "how-to/iterate-a-spec.rst", "how-to/run-container.md", "how-to/serialize-a-spec.rst", "index.md", "reference.md", "reference/rest_api.md", "tutorials.md", "tutorials/creating-a-spec.rst", "tutorials/installation.md", "tutorials/rest-service.rst"], "indexentries": {"__version__ (in module scanspec)": [[1, "scanspec.__version__", false]], "angle (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.angle", false]], "angle (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.angle", false]], "axes (scanspec.core.midpoints property)": [[2, "scanspec.core.Midpoints.axes", false]], "axes() (scanspec.core.frames method)": [[2, "scanspec.core.Frames.axes", false]], "axes() (scanspec.specs.concat method)": [[5, "scanspec.specs.Concat.axes", false]], "axes() (scanspec.specs.line method)": [[5, "scanspec.specs.Line.axes", false]], "axes() (scanspec.specs.mask method)": [[5, "scanspec.specs.Mask.axes", false]], "axes() (scanspec.specs.product method)": [[5, "scanspec.specs.Product.axes", false]], "axes() (scanspec.specs.repeat method)": [[5, "scanspec.specs.Repeat.axes", false]], "axes() (scanspec.specs.snake method)": [[5, "scanspec.specs.Snake.axes", false]], "axes() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.axes", false]], "axes() (scanspec.specs.spiral method)": [[5, "scanspec.specs.Spiral.axes", false]], "axes() (scanspec.specs.squash method)": [[5, "scanspec.specs.Squash.axes", false]], "axes() (scanspec.specs.static method)": [[5, "scanspec.specs.Static.axes", false]], "axes() (scanspec.specs.zip method)": [[5, "scanspec.specs.Zip.axes", false]], "axespoints (in module scanspec.core)": [[2, "scanspec.core.AxesPoints", false]], "axis (class in scanspec.core)": [[2, "scanspec.core.Axis", false]], "axis (scanspec.regions.range attribute)": [[4, "scanspec.regions.Range.axis", false]], "axis (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.axis", false]], "axis (scanspec.specs.static attribute)": [[5, "scanspec.specs.Static.axis", false]], "axis_sets() (scanspec.regions.circle method)": [[4, "scanspec.regions.Circle.axis_sets", false]], "axis_sets() (scanspec.regions.combinationof method)": [[4, "scanspec.regions.CombinationOf.axis_sets", false]], "axis_sets() (scanspec.regions.ellipse method)": [[4, "scanspec.regions.Ellipse.axis_sets", false]], "axis_sets() (scanspec.regions.polygon method)": [[4, "scanspec.regions.Polygon.axis_sets", false]], "axis_sets() (scanspec.regions.range method)": [[4, "scanspec.regions.Range.axis_sets", false]], "axis_sets() (scanspec.regions.rectangle method)": [[4, "scanspec.regions.Rectangle.axis_sets", false]], "axis_sets() (scanspec.regions.region method)": [[4, "scanspec.regions.Region.axis_sets", false]], "bounded() (scanspec.specs.line method)": [[5, "scanspec.specs.Line.bounded", false]], "calculate() (scanspec.specs.concat method)": [[5, "scanspec.specs.Concat.calculate", false]], "calculate() (scanspec.specs.line method)": [[5, "scanspec.specs.Line.calculate", false]], "calculate() (scanspec.specs.mask method)": [[5, "scanspec.specs.Mask.calculate", false]], "calculate() (scanspec.specs.product method)": [[5, "scanspec.specs.Product.calculate", false]], "calculate() (scanspec.specs.repeat method)": [[5, "scanspec.specs.Repeat.calculate", false]], "calculate() (scanspec.specs.snake method)": [[5, "scanspec.specs.Snake.calculate", false]], "calculate() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.calculate", false]], "calculate() (scanspec.specs.spiral method)": [[5, "scanspec.specs.Spiral.calculate", false]], "calculate() (scanspec.specs.squash method)": [[5, "scanspec.specs.Squash.calculate", false]], "calculate() (scanspec.specs.static method)": [[5, "scanspec.specs.Static.calculate", false]], "calculate() (scanspec.specs.zip method)": [[5, "scanspec.specs.Zip.calculate", false]], "check_path_changes (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.check_path_changes", false]], "check_path_changes (scanspec.specs.mask attribute)": [[5, "scanspec.specs.Mask.check_path_changes", false]], "check_path_changes (scanspec.specs.squash attribute)": [[5, "scanspec.specs.Squash.check_path_changes", false]], "concat() (scanspec.core.frames method)": [[2, "scanspec.core.Frames.concat", false]], "concat() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.concat", false]], "consume() (scanspec.core.path method)": [[2, "scanspec.core.Path.consume", false]], "deserialize() (scanspec.regions.region static method)": [[4, "scanspec.regions.Region.deserialize", false]], "deserialize() (scanspec.specs.spec static method)": [[5, "scanspec.specs.Spec.deserialize", false]], "discriminated_union_of_subclasses() (in module scanspec.core)": [[2, "scanspec.core.discriminated_union_of_subclasses", false]], "duration (in module scanspec.specs)": [[5, "scanspec.specs.DURATION", false]], "duration() (scanspec.specs.static method)": [[5, "scanspec.specs.Static.duration", false]], "end_index (scanspec.core.path attribute)": [[2, "scanspec.core.Path.end_index", false]], "extract() (scanspec.core.frames method)": [[2, "scanspec.core.Frames.extract", false]], "extract() (scanspec.core.snakedframes method)": [[2, "scanspec.core.SnakedFrames.extract", false]], "find_regions() (in module scanspec.regions)": [[4, "scanspec.regions.find_regions", false]], "fly() (in module scanspec.specs)": [[5, "scanspec.specs.fly", false]], "frames (class in scanspec.core)": [[2, "scanspec.core.Frames", false]], "frames() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.frames", false]], "from_frames() (scanspec.core.snakedframes class method)": [[2, "scanspec.core.SnakedFrames.from_frames", false]], "gap (scanspec.core.frames attribute)": [[2, "scanspec.core.Frames.gap", false]], "gap (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.gap", false]], "gap (scanspec.specs.repeat attribute)": [[5, "scanspec.specs.Repeat.gap", false]], "gap_between_frames() (in module scanspec.core)": [[2, "scanspec.core.gap_between_frames", false]], "get_mask() (in module scanspec.regions)": [[4, "scanspec.regions.get_mask", false]], "if_instance_do() (in module scanspec.core)": [[2, "scanspec.core.if_instance_do", false]], "index (scanspec.core.path attribute)": [[2, "scanspec.core.Path.index", false]], "inner (scanspec.specs.product attribute)": [[5, "scanspec.specs.Product.inner", false]], "left (scanspec.regions.combinationof attribute)": [[4, "scanspec.regions.CombinationOf.left", false]], "left (scanspec.regions.differenceof attribute)": [[4, "scanspec.regions.DifferenceOf.left", false]], "left (scanspec.regions.intersectionof attribute)": [[4, "scanspec.regions.IntersectionOf.left", false]], "left (scanspec.regions.symmetricdifferenceof attribute)": [[4, "scanspec.regions.SymmetricDifferenceOf.left", false]], "left (scanspec.regions.unionof attribute)": [[4, "scanspec.regions.UnionOf.left", false]], "left (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.left", false]], "left (scanspec.specs.zip attribute)": [[5, "scanspec.specs.Zip.left", false]], "lengths (scanspec.core.path attribute)": [[2, "scanspec.core.Path.lengths", false]], "lower (scanspec.core.frames attribute)": [[2, "scanspec.core.Frames.lower", false]], "mask() (scanspec.regions.circle method)": [[4, "scanspec.regions.Circle.mask", false]], "mask() (scanspec.regions.differenceof method)": [[4, "scanspec.regions.DifferenceOf.mask", false]], "mask() (scanspec.regions.ellipse method)": [[4, "scanspec.regions.Ellipse.mask", false]], "mask() (scanspec.regions.intersectionof method)": [[4, "scanspec.regions.IntersectionOf.mask", false]], "mask() (scanspec.regions.polygon method)": [[4, "scanspec.regions.Polygon.mask", false]], "mask() (scanspec.regions.range method)": [[4, "scanspec.regions.Range.mask", false]], "mask() (scanspec.regions.rectangle method)": [[4, "scanspec.regions.Rectangle.mask", false]], "mask() (scanspec.regions.region method)": [[4, "scanspec.regions.Region.mask", false]], "mask() (scanspec.regions.symmetricdifferenceof method)": [[4, "scanspec.regions.SymmetricDifferenceOf.mask", false]], "mask() (scanspec.regions.unionof method)": [[4, "scanspec.regions.UnionOf.mask", false]], "max (scanspec.regions.range attribute)": [[4, "scanspec.regions.Range.max", false]], "midpoints (class in scanspec.core)": [[2, "scanspec.core.Midpoints", false]], "midpoints (scanspec.core.frames attribute)": [[2, "scanspec.core.Frames.midpoints", false]], "midpoints() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.midpoints", false]], "min (scanspec.regions.range attribute)": [[4, "scanspec.regions.Range.min", false]], "module": [[1, "module-scanspec", false], [2, "module-scanspec.core", false], [3, "module-scanspec.plot", false], [4, "module-scanspec.regions", false], [5, "module-scanspec.specs", false]], "num (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.num", false]], "num (scanspec.specs.repeat attribute)": [[5, "scanspec.specs.Repeat.num", false]], "num (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.num", false]], "num (scanspec.specs.static attribute)": [[5, "scanspec.specs.Static.num", false]], "otheraxis (class in scanspec.core)": [[2, "scanspec.core.OtherAxis", false]], "outer (scanspec.specs.product attribute)": [[5, "scanspec.specs.Product.outer", false]], "path (class in scanspec.core)": [[2, "scanspec.core.Path", false]], "plot_spec() (in module scanspec.plot)": [[3, "scanspec.plot.plot_spec", false]], "radius (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.radius", false]], "region (class in scanspec.regions)": [[4, "scanspec.regions.Region", false]], "region (scanspec.specs.mask attribute)": [[5, "scanspec.specs.Mask.region", false]], "right (scanspec.regions.combinationof attribute)": [[4, "scanspec.regions.CombinationOf.right", false]], "right (scanspec.regions.differenceof attribute)": [[4, "scanspec.regions.DifferenceOf.right", false]], "right (scanspec.regions.intersectionof attribute)": [[4, "scanspec.regions.IntersectionOf.right", false]], "right (scanspec.regions.symmetricdifferenceof attribute)": [[4, "scanspec.regions.SymmetricDifferenceOf.right", false]], "right (scanspec.regions.unionof attribute)": [[4, "scanspec.regions.UnionOf.right", false]], "right (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.right", false]], "right (scanspec.specs.zip attribute)": [[5, "scanspec.specs.Zip.right", false]], "rotate (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.rotate", false]], "scanspec": [[1, "module-scanspec", false]], "scanspec.core": [[2, "module-scanspec.core", false]], "scanspec.plot": [[3, "module-scanspec.plot", false]], "scanspec.regions": [[4, "module-scanspec.regions", false]], "scanspec.specs": [[5, "module-scanspec.specs", false]], "serialize() (scanspec.regions.region method)": [[4, "scanspec.regions.Region.serialize", false]], "serialize() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.serialize", false]], "shape() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.shape", false]], "snakedframes (class in scanspec.core)": [[2, "scanspec.core.SnakedFrames", false]], "spaced() (scanspec.specs.spiral method)": [[5, "scanspec.specs.Spiral.spaced", false]], "spec (class in scanspec.specs)": [[5, "scanspec.specs.Spec", false]], "spec (scanspec.specs.mask attribute)": [[5, "scanspec.specs.Mask.spec", false]], "spec (scanspec.specs.snake attribute)": [[5, "scanspec.specs.Snake.spec", false]], "spec (scanspec.specs.squash attribute)": [[5, "scanspec.specs.Squash.spec", false]], "squash_frames() (in module scanspec.core)": [[2, "scanspec.core.squash_frames", false]], "stack (scanspec.core.midpoints attribute)": [[2, "scanspec.core.Midpoints.stack", false]], "stack (scanspec.core.path attribute)": [[2, "scanspec.core.Path.stack", false]], "start (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.start", false]], "step() (in module scanspec.specs)": [[5, "scanspec.specs.step", false]], "stop (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.stop", false]], "strictconfig (in module scanspec.core)": [[2, "scanspec.core.StrictConfig", false]], "type (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.type", false]], "type (scanspec.regions.combinationof attribute)": [[4, "scanspec.regions.CombinationOf.type", false]], "type (scanspec.regions.differenceof attribute)": [[4, "scanspec.regions.DifferenceOf.type", false]], "type (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.type", false]], "type (scanspec.regions.intersectionof attribute)": [[4, "scanspec.regions.IntersectionOf.type", false]], "type (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.type", false]], "type (scanspec.regions.range attribute)": [[4, "scanspec.regions.Range.type", false]], "type (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.type", false]], "type (scanspec.regions.symmetricdifferenceof attribute)": [[4, "scanspec.regions.SymmetricDifferenceOf.type", false]], "type (scanspec.regions.unionof attribute)": [[4, "scanspec.regions.UnionOf.type", false]], "type (scanspec.specs.concat attribute)": [[5, "scanspec.specs.Concat.type", false]], "type (scanspec.specs.line attribute)": [[5, "scanspec.specs.Line.type", false]], "type (scanspec.specs.mask attribute)": [[5, "scanspec.specs.Mask.type", false]], "type (scanspec.specs.product attribute)": [[5, "scanspec.specs.Product.type", false]], "type (scanspec.specs.repeat attribute)": [[5, "scanspec.specs.Repeat.type", false]], "type (scanspec.specs.snake attribute)": [[5, "scanspec.specs.Snake.type", false]], "type (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.type", false]], "type (scanspec.specs.squash attribute)": [[5, "scanspec.specs.Squash.type", false]], "type (scanspec.specs.static attribute)": [[5, "scanspec.specs.Static.type", false]], "type (scanspec.specs.zip attribute)": [[5, "scanspec.specs.Zip.type", false]], "upper (scanspec.core.frames attribute)": [[2, "scanspec.core.Frames.upper", false]], "value (scanspec.specs.static attribute)": [[5, "scanspec.specs.Static.value", false]], "x_axis (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.x_axis", false]], "x_axis (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.x_axis", false]], "x_axis (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.x_axis", false]], "x_axis (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.x_axis", false]], "x_axis (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.x_axis", false]], "x_max (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.x_max", false]], "x_middle (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.x_middle", false]], "x_middle (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.x_middle", false]], "x_min (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.x_min", false]], "x_radius (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.x_radius", false]], "x_range (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.x_range", false]], "x_start (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.x_start", false]], "x_verts (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.x_verts", false]], "y_axis (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.y_axis", false]], "y_axis (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.y_axis", false]], "y_axis (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.y_axis", false]], "y_axis (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.y_axis", false]], "y_axis (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.y_axis", false]], "y_max (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.y_max", false]], "y_middle (scanspec.regions.circle attribute)": [[4, "scanspec.regions.Circle.y_middle", false]], "y_middle (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.y_middle", false]], "y_min (scanspec.regions.rectangle attribute)": [[4, "scanspec.regions.Rectangle.y_min", false]], "y_radius (scanspec.regions.ellipse attribute)": [[4, "scanspec.regions.Ellipse.y_radius", false]], "y_range (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.y_range", false]], "y_start (scanspec.specs.spiral attribute)": [[5, "scanspec.specs.Spiral.y_start", false]], "y_verts (scanspec.regions.polygon attribute)": [[4, "scanspec.regions.Polygon.y_verts", false]], "zip() (scanspec.core.frames method)": [[2, "scanspec.core.Frames.zip", false]], "zip() (scanspec.specs.spec method)": [[5, "scanspec.specs.Spec.zip", false]]}, "objects": {"": [[21, 0, 1, "post--bounds", "/bounds"], [21, 0, 1, "post--gap", "/gap"], [21, 0, 1, "post--midpoints", "/midpoints"], [21, 0, 1, "post--smalleststep", "/smalleststep"], [21, 0, 1, "post--valid", "/valid"], [1, 1, 0, "-", "scanspec"]], "scanspec": [[1, 2, 1, "", "__version__"], [2, 1, 0, "-", "core"], [3, 1, 0, "-", "plot"], [4, 1, 0, "-", "regions"], [5, 1, 0, "-", "specs"]], "scanspec.core": [[2, 2, 1, "", "AxesPoints"], [2, 3, 1, "", "Axis"], [2, 3, 1, "", "Frames"], [2, 3, 1, "", "Midpoints"], [2, 3, 1, "", "OtherAxis"], [2, 3, 1, "", "Path"], [2, 3, 1, "", "SnakedFrames"], [2, 2, 1, "", "StrictConfig"], [2, 7, 1, "", "discriminated_union_of_subclasses"], [2, 7, 1, "", "gap_between_frames"], [2, 7, 1, "", "if_instance_do"], [2, 7, 1, "", "squash_frames"]], "scanspec.core.Frames": [[2, 4, 1, "", "axes"], [2, 4, 1, "", "concat"], [2, 4, 1, "", "extract"], [2, 5, 1, "", "gap"], [2, 5, 1, "", "lower"], [2, 5, 1, "", "midpoints"], [2, 5, 1, "", "upper"], [2, 4, 1, "", "zip"]], "scanspec.core.Midpoints": [[2, 6, 1, "", "axes"], [2, 5, 1, "", "stack"]], "scanspec.core.Path": [[2, 4, 1, "", "consume"], [2, 5, 1, "", "end_index"], [2, 5, 1, "", "index"], [2, 5, 1, "", "lengths"], [2, 5, 1, "", "stack"]], "scanspec.core.SnakedFrames": [[2, 4, 1, "", "extract"], [2, 4, 1, "", "from_frames"]], "scanspec.plot": [[3, 7, 1, "", "plot_spec"]], "scanspec.regions": [[4, 8, 1, "", "Circle"], [4, 8, 1, "", "CombinationOf"], [4, 8, 1, "", "DifferenceOf"], [4, 8, 1, "", "Ellipse"], [4, 8, 1, "", "IntersectionOf"], [4, 8, 1, "", "Polygon"], [4, 8, 1, "", "Range"], [4, 8, 1, "", "Rectangle"], [4, 3, 1, "", "Region"], [4, 8, 1, "", "SymmetricDifferenceOf"], [4, 8, 1, "", "UnionOf"], [4, 7, 1, "", "find_regions"], [4, 7, 1, "", "get_mask"]], "scanspec.regions.Circle": [[4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "radius"], [4, 9, 1, "", "type"], [4, 9, 1, "", "x_axis"], [4, 9, 1, "", "x_middle"], [4, 9, 1, "", "y_axis"], [4, 9, 1, "", "y_middle"]], "scanspec.regions.CombinationOf": [[4, 4, 1, "", "axis_sets"], [4, 9, 1, "", "left"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.regions.DifferenceOf": [[4, 9, 1, "", "left"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.regions.Ellipse": [[4, 9, 1, "", "angle"], [4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "type"], [4, 9, 1, "", "x_axis"], [4, 9, 1, "", "x_middle"], [4, 9, 1, "", "x_radius"], [4, 9, 1, "", "y_axis"], [4, 9, 1, "", "y_middle"], [4, 9, 1, "", "y_radius"]], "scanspec.regions.IntersectionOf": [[4, 9, 1, "", "left"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.regions.Polygon": [[4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "type"], [4, 9, 1, "", "x_axis"], [4, 9, 1, "", "x_verts"], [4, 9, 1, "", "y_axis"], [4, 9, 1, "", "y_verts"]], "scanspec.regions.Range": [[4, 9, 1, "", "axis"], [4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "max"], [4, 9, 1, "", "min"], [4, 9, 1, "", "type"]], "scanspec.regions.Rectangle": [[4, 9, 1, "", "angle"], [4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "type"], [4, 9, 1, "", "x_axis"], [4, 9, 1, "", "x_max"], [4, 9, 1, "", "x_min"], [4, 9, 1, "", "y_axis"], [4, 9, 1, "", "y_max"], [4, 9, 1, "", "y_min"]], "scanspec.regions.Region": [[4, 4, 1, "", "axis_sets"], [4, 4, 1, "", "deserialize"], [4, 4, 1, "", "mask"], [4, 4, 1, "", "serialize"]], "scanspec.regions.SymmetricDifferenceOf": [[4, 9, 1, "", "left"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.regions.UnionOf": [[4, 9, 1, "", "left"], [4, 4, 1, "", "mask"], [4, 9, 1, "", "right"], [4, 9, 1, "", "type"]], "scanspec.specs": [[5, 8, 1, "", "Concat"], [5, 2, 1, "", "DURATION"], [5, 8, 1, "", "Line"], [5, 8, 1, "", "Mask"], [5, 8, 1, "", "Product"], [5, 8, 1, "", "Repeat"], [5, 8, 1, "", "Snake"], [5, 3, 1, "", "Spec"], [5, 8, 1, "", "Spiral"], [5, 8, 1, "", "Squash"], [5, 8, 1, "", "Static"], [5, 8, 1, "", "Zip"], [5, 7, 1, "", "fly"], [5, 7, 1, "", "step"]], "scanspec.specs.Concat": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "check_path_changes"], [5, 9, 1, "", "gap"], [5, 9, 1, "", "left"], [5, 9, 1, "", "right"], [5, 9, 1, "", "type"]], "scanspec.specs.Line": [[5, 4, 1, "", "axes"], [5, 9, 1, "", "axis"], [5, 4, 1, "", "bounded"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "num"], [5, 9, 1, "", "start"], [5, 9, 1, "", "stop"], [5, 9, 1, "", "type"]], "scanspec.specs.Mask": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "check_path_changes"], [5, 9, 1, "", "region"], [5, 9, 1, "", "spec"], [5, 9, 1, "", "type"]], "scanspec.specs.Product": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "inner"], [5, 9, 1, "", "outer"], [5, 9, 1, "", "type"]], "scanspec.specs.Repeat": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "gap"], [5, 9, 1, "", "num"], [5, 9, 1, "", "type"]], "scanspec.specs.Snake": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "spec"], [5, 9, 1, "", "type"]], "scanspec.specs.Spec": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 4, 1, "", "concat"], [5, 4, 1, "", "deserialize"], [5, 4, 1, "", "frames"], [5, 4, 1, "", "midpoints"], [5, 4, 1, "", "serialize"], [5, 4, 1, "", "shape"], [5, 4, 1, "", "zip"]], "scanspec.specs.Spiral": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "num"], [5, 9, 1, "", "rotate"], [5, 4, 1, "", "spaced"], [5, 9, 1, "", "type"], [5, 9, 1, "", "x_axis"], [5, 9, 1, "", "x_range"], [5, 9, 1, "", "x_start"], [5, 9, 1, "", "y_axis"], [5, 9, 1, "", "y_range"], [5, 9, 1, "", "y_start"]], "scanspec.specs.Squash": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "check_path_changes"], [5, 9, 1, "", "spec"], [5, 9, 1, "", "type"]], "scanspec.specs.Static": [[5, 4, 1, "", "axes"], [5, 9, 1, "", "axis"], [5, 4, 1, "", "calculate"], [5, 4, 1, "", "duration"], [5, 9, 1, "", "num"], [5, 9, 1, "", "type"], [5, 9, 1, "", "value"]], "scanspec.specs.Zip": [[5, 4, 1, "", "axes"], [5, 4, 1, "", "calculate"], [5, 9, 1, "", "left"], [5, 9, 1, "", "right"], [5, 9, 1, "", "type"]]}, "objnames": {"0": ["http", "post", "HTTP post"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "method", "Python method"], "5": ["py", "attribute", "Python attribute"], "6": ["py", "property", "Python property"], "7": ["py", "function", "Python function"], "8": ["py", "pydantic_model", "Python model"], "9": ["py", "pydantic_field", "Python field"]}, "objtypes": {"0": "http:post", "1": "py:module", "2": "py:data", "3": "py:class", "4": "py:method", "5": "py:attribute", "6": "py:property", "7": "py:function", "8": "py:pydantic_model", "9": "py:pydantic_field"}, "terms": {"": [7, 8, 15], "0": [2, 3, 4, 5, 11, 12, 16, 18, 19, 21, 23, 25], "000000000000002": 25, "1": [2, 3, 4, 5, 7, 11, 12, 16, 18, 19, 23], "10": [2, 3, 4, 5, 19, 24, 25], "100": [12, 15], "100x2000x2000": 12, "1024": 25, "12": [5, 19, 25], "13": 2, "15": 10, "18": 12, "1818181818181817": 19, "1d": [10, 23], "2": [2, 3, 4, 5, 7, 12, 16, 18, 19], "200": [3, 21], "2000": 12, "25": 16, "2d": [3, 19], "2gb": 12, "3": [2, 3, 4, 5, 11, 12, 16, 18, 19, 23, 24, 25], "30": [4, 5, 19], "32": 12, "333333333333333": 25, "4": [2, 4, 5, 12, 18, 19, 23, 25], "422": [21, 25], "44": 19, "5": [2, 4, 5, 10, 12, 16, 18, 19, 23, 25], "50": 5, "6": [2, 4, 5, 12, 18, 23, 25], "666666666666667": 25, "7": 2, "7222222222222222": 19, "75": [4, 5, 16], "8": [4, 5, 12, 19], "8080": 25, "8333333333333333": 19, "8kb": 12, "9": [3, 4, 5], "A": [2, 4, 5, 10, 11, 12, 16, 21], "As": [7, 9], "For": [2, 7, 11, 12, 15, 16, 23], "If": [2, 3, 4, 5, 10, 11, 12, 15, 23, 24], "In": [10, 16, 25], "It": [2, 5, 15, 19, 24], "On": 16, "The": [2, 4, 5, 9, 11, 12, 21, 23, 24, 25], "There": [5, 25], "These": [2, 23], "To": [8, 16, 17, 23, 25], "Will": 5, "__version__": 1, "_stack_": 10, "abc": 2, "abl": 11, "abov": [2, 8, 10, 11, 12, 23], "absolut": 21, "abstract": [4, 5], "abstractmethod": 2, "accept": [8, 9, 25], "access": 19, "activ": [10, 24], "actual": [2, 12], "ad": [2, 23], "add": 2, "additionalproperti": [4, 5], "adopt": 7, "adr": [7, 8], "advis": 12, "after": [2, 5, 11, 21], "alia": 2, "all": [2, 4, 5, 12, 15], "allow": [11, 25], "along": [2, 4, 5, 10, 12], "alreadi": 17, "also": [5, 15, 16, 19, 24], "altern": 2, "alwai": 11, "an": [2, 4, 5, 10, 11, 18, 19, 21, 23], "angl": [4, 5], "ani": [2, 3, 4, 5, 12, 15, 21, 24], "annot": 5, "anoth": [5, 10, 11], "apart": 11, "api": [1, 19, 20, 25], "appear": 5, "appli": 23, "applic": 25, "ar": [2, 3, 4, 5, 7, 10, 11, 12, 15, 16, 17, 19, 21, 23, 25], "archimedean": 5, "architectur": [6, 19], "arg": 21, "argument": 2, "arrai": [2, 4, 5, 10, 12, 16, 21], "arrow": [5, 23], "arrowhead": 23, "articl": 8, "ask": 15, "assert": [2, 5], "attribut": 16, "avail": [10, 17], "avoid": 5, "ax": [2, 4, 5, 10, 19], "axespoint": 2, "axi": [2, 4, 5, 12, 16, 18, 21, 25], "axis_set": 4, "b": [4, 5], "back": [16, 18], "bar": 19, "baseclass": [4, 5], "basemodel": 2, "becaus": 25, "been": 24, "befor": 15, "below": [7, 11, 21], "better": 2, "between": [2, 5, 11, 21, 23], "big": 15, "bin": 24, "bind": 2, "black": [3, 23], "blog": 7, "blueski": [17, 19, 24], "bool": [2, 4, 5], "boolean": 5, "both": [2, 4, 5, 21], "bound": [2, 5, 16, 19, 21, 23], "boundsrespons": 21, "bracket": 5, "bring": 25, "browser": 25, "bug": 15, "built": 17, "c": [2, 25], "calcul": [1, 2, 5, 10, 12, 16, 19, 21], "calculate_gap": 2, "callabl": 2, "can": [2, 4, 5, 6, 9, 10, 12, 15, 16, 18, 19, 21, 23, 24, 25], "canon": 21, "case": 11, "categori": 19, "caught": 15, "caus": 12, "cd": 9, "centr": [5, 23], "central": [4, 5], "chang": [2, 5, 6, 9, 12, 15, 19], "check": [2, 5, 15, 16], "check_path_chang": [2, 5, 11], "children": 4, "chunk": [2, 16, 19], "ci": 9, "circl": [3, 4, 5, 12, 19, 23], "cl": 2, "class": [2, 4, 5], "classmethod": 2, "client": [23, 25], "clockwis": [4, 5], "close": 15, "code": [2, 3, 4, 5, 11, 21, 23, 25], "colour": [3, 10, 23], "com": 24, "combin": [4, 5, 19, 23], "combinationof": [4, 5], "command": 25, "commandlin": [24, 25], "commit": 15, "common": 15, "compact": 12, "compar": 11, "compat": 25, "complex": 23, "compos": 19, "concat": [2, 5, 19], "concaten": [2, 5], "conduct": 16, "configdict": 2, "configur": 15, "consecut": 5, "consid": [10, 11, 12], "consist": 9, "const": [4, 5], "constraint": [4, 5], "consum": [2, 10, 16, 19], "contain": [4, 5, 10, 12, 14, 15, 16, 19], "container": 15, "content": 25, "continu": 5, "contribut": [14, 19], "conveni": [2, 19], "coordin": [4, 5, 25], "copi": 8, "copier": [7, 15], "cor": 25, "core": [4, 5, 16, 19], "correspond": 21, "could": [9, 11, 16, 23], "covari": 2, "creat": [2, 4, 5, 6, 8, 10, 11, 15, 16, 19, 22, 25], "cross": 23, "ctrl": 25, "cube": 3, "curl": 25, "current": 24, "cycler": 19, "d": [16, 25], "data": [11, 12], "dataclass": 2, "decis": [6, 19], "decor": 2, "def": [2, 4, 5], "default": [2, 4, 5], "defin": [2, 23], "degre": [4, 5], "demand": 11, "demonstr": 23, "denot": 10, "depend": [12, 17, 24], "describ": [2, 8, 10], "descript": [4, 5, 21], "deseri": [2, 4, 5, 14, 19, 23], "destroi": 12, "detail": 12, "detector": [10, 11], "determin": 2, "devcontain": 15, "develop": 9, "diagram": 10, "diamond": 15, "dict": [2, 4], "dictionari": [2, 4, 5, 16, 18], "differ": [2, 3, 5, 9, 10], "differenceof": [4, 5, 23], "dimens": 5, "dimension": [11, 12, 19], "direct": 11, "directli": 19, "discrimin": [2, 4, 5], "discriminated_union_of_subclass": 2, "disjoint": 23, "disk": 12, "do": [5, 23, 24, 25], "doc": 25, "docker": [17, 19], "document": [2, 10, 21], "doe": 15, "don": 15, "dot": 23, "down": 5, "dr": 5, "draw": [3, 10], "dtype": [2, 4], "durat": [5, 10, 19], "dure": 2, "e": [2, 10, 21], "each": [2, 3, 5, 10, 11, 12, 16, 19, 21, 23, 25], "earlier": 5, "easili": 15, "editor": 25, "effici": 19, "either": [2, 4, 5], "element": 2, "ellips": [4, 5], "empti": 5, "end": [2, 5, 15, 23], "end_index": 2, "endpoint": [21, 25], "enough": 16, "ensur": [2, 9, 25], "enter": 23, "entir": 16, "entireti": 5, "entiti": 21, "enum": [4, 5], "environ": [9, 15], "equal": 5, "error": [2, 21, 25], "evalu": 23, "even": 11, "everi": [5, 11], "exampl": [2, 3, 4, 5, 11, 16, 18, 19, 23, 25], "example_spec": [4, 5], "exclud": 5, "exclusiveminimum": [4, 5], "execut": [5, 12, 16], "exist": [8, 15, 24], "expand": [5, 19], "experienc": [14, 19], "explan": 19, "explicitli": 11, "expos": 25, "express": 2, "extend": 2, "extra": [2, 24], "extract": 2, "extrem": 5, "fail": 11, "fall": 5, "fals": [2, 4, 5, 11, 16], "faster": [2, 12], "fastest": [2, 5, 12], "featur": 24, "few": 16, "field": [2, 4, 5], "fieldinfo": 5, "file": 15, "fill": 3, "final": 5, "find_region": 4, "first": [2, 4, 5, 11, 12, 16, 23], "fit": [15, 16], "fix": [5, 9, 10], "flag": 11, "float": [2, 4, 5], "float64": [12, 16], "float_list": 25, "fly": [2, 5, 10, 12, 19], "flyscan": [5, 19], "follow": [9, 23], "forbid": 2, "forc": [2, 5], "form": [2, 5, 12], "format": [9, 21, 25], "forth": 16, "four": 19, "frame": [2, 3, 5, 6, 16, 19, 21, 23], "frames1": 2, "frames2": 2, "free": 15, "from": [2, 3, 4, 5, 8, 9, 10, 11, 12, 16, 17, 18, 19, 21, 24], "from_fram": 2, "func": 2, "function": 23, "fx": 2, "fy": 2, "g": 2, "gap": [2, 5, 21], "gap_between_fram": 2, "gaprespons": 21, "ge": 5, "gener": [19, 21, 22, 24], "get": [16, 17, 23], "get_mask": 4, "ghcr": [17, 19], "git": 24, "github": [15, 17, 19, 24], "give": [12, 16, 25], "given": [2, 4, 5, 10, 19, 23], "graph": 23, "great": 15, "grei": [3, 23], "grid": [4, 5, 10, 12, 16, 19], "gt": 4, "guarante": 23, "gui": 25, "guid": [15, 19], "h": 25, "ha": [18, 23, 24], "had": 11, "hand": [4, 5], "handl": [2, 15], "have": [2, 5, 9, 12, 15, 16], "hdf": 12, "height": 5, "helper": 2, "here": [19, 22, 23], "hire": [3, 4, 5, 11, 23], "hold": 12, "hook": 15, "how": [2, 5, 6, 15, 23, 25], "howev": 12, "http": [19, 24, 25], "i": [2, 3, 4, 5, 10, 11, 12, 15, 21, 23, 24, 25], "idea": 15, "identifi": [2, 5], "if_instance_do": 2, "ignor": 21, "illustr": 11, "imag": 12, "imagin": 12, "implement": 2, "import": [3, 4, 5, 11, 12, 16, 18, 19, 23], "improv": 15, "includ": [19, 20, 23], "inclus": [4, 5], "increas": 23, "index": [2, 19, 20], "indic": [2, 5, 21, 23], "individu": 5, "info": 21, "inform": [7, 12, 16], "inherit": 2, "inner": [5, 12, 18, 23, 25], "input": [2, 23], "insert": [2, 16], "insid": [4, 5, 19], "inspect": 25, "instal": [17, 19, 22], "instanc": 16, "instanti": 18, "instead": [2, 5, 15, 17], "int": [2, 5], "int64": 2, "integ": 5, "inter": 10, "interact": 23, "interfac": 24, "interfer": 24, "intermedi": 16, "interpret": [2, 12], "intersectionof": [4, 5, 23], "intliter": 2, "invalid": 11, "invari": 11, "involv": 15, "io": [17, 19], "item": [4, 5], "iter": [2, 4, 5, 11, 12, 14, 19, 23], "its": [2, 4, 5, 12, 15, 17, 18, 24], "itself": 12, "join": 5, "json": [2, 4, 5, 25], "jump": 11, "just": 12, "keep": [7, 11, 16], "kei": 5, "l1": 5, "l2": 5, "last": [2, 5, 16, 23], "later": [5, 24], "latest": [9, 17, 19], "left": [2, 4, 5], "len": [2, 5, 12, 16, 19], "length": [2, 10, 19], "less": 3, "let": [12, 18], "level": 1, "librari": 15, "lifetim": 7, "light": 15, "like": [2, 12, 15, 19, 23, 25], "line": [3, 4, 5, 10, 11, 12, 16, 18, 19, 25], "linear": 2, "linearli": 5, "link": [8, 19], "lint": 9, "list": [2, 4, 5, 7, 10, 11, 12], "liter": [4, 5], "ll": 23, "localhost": 25, "locat": 10, "long": [5, 12], "look": [2, 19], "lower": [2, 5, 10, 12, 16, 21, 23], "m": 24, "machin": 16, "made": [7, 8, 10], "mai": [2, 9, 11, 16, 21, 23], "make": [11, 12, 15, 23], "manag": 9, "mani": [5, 16], "map": [2, 4, 5, 25], "mark": [3, 23], "mask": [2, 4, 5, 6, 12, 19], "match": [4, 5], "materi": [19, 20], "max": [4, 5], "max_fram": 25, "maximum": [4, 5, 16, 21], "mean": [2, 5, 11, 12], "member": [2, 3, 4, 5], "memori": [12, 16], "merg": [2, 5, 11], "metadata": 5, "method": 16, "michael": [7, 8], "middl": [4, 5, 21, 25], "midpoint": [2, 3, 4, 5, 10, 12, 19, 21, 23], "midpointsrespons": 21, "might": [15, 23], "min": [4, 5], "min_length": 4, "minimum": [4, 5, 21], "minitem": [4, 5], "miss": 25, "model": [4, 5], "modifi": 5, "modul": 9, "modulo": 2, "more": [2, 7, 11, 14, 15, 19], "most": [2, 12, 15, 25], "motion": [5, 23], "motor": [10, 11, 16], "move": [2, 5, 11, 12, 16], "mp": 2, "much": 5, "multidimension": 10, "multipl": [5, 19], "must": [2, 5, 11], "my_sum": 2, "n": [4, 5], "name": [2, 4, 5, 25], "narrai": [4, 5], "ncan": 5, "ncombin": 5, "ndarrai": [2, 4, 19], "neach": 5, "necessarili": 2, "need": [2, 5, 8, 11, 12, 15, 24], "neg": 11, "nest": [2, 5, 11, 12], "new": [2, 8, 15, 16, 19, 22], "next": 2, "nform": 5, "nice": 25, "nif": 5, "non": [4, 11, 12], "none": [2, 3], "note": [5, 19, 20], "notimpl": 2, "now": [24, 25], "np": [2, 4, 5, 16], "nproduc": 5, "nsee": 5, "nstack": 5, "nstart": 5, "nthi": 5, "ntypic": [4, 5], "num": [2, 5, 16, 18, 19, 25], "number": [1, 2, 4, 5, 10, 11, 12, 15, 17], "numpi": 16, "nx1": [4, 5], "nygard": [7, 8], "obj": [4, 5], "object": [2, 4, 5, 10, 11, 12, 16], "obviou": 15, "offer": 15, "ok": 21, "onc": [2, 5, 11, 12, 16], "one": [2, 4, 5, 11, 15, 16, 23], "oneof": [4, 5], "ones": [4, 8], "onli": [5, 11, 23], "open": [15, 25], "openapi": 25, "oper": [2, 4, 5, 23], "operand": 5, "option": 19, "order": [2, 5, 11], "organis": 25, "origin": 11, "other": [2, 5, 11], "otheraxi": [2, 5], "otherwis": [2, 4, 11, 21], "our": [12, 23], "out": [12, 16], "outer": [5, 12, 18, 25], "output": [2, 5, 23, 25], "outsid": 5, "over": [12, 19], "overlap": 4, "overload": 2, "own": 15, "p": 2, "packag": 9, "page": [10, 11], "parallel": 5, "param": 2, "paramet": [2, 5, 12, 18, 25], "parse_obj_a": 2, "part": 2, "particularli": 16, "pass": [2, 11, 25], "past": [2, 8], "path": [2, 3, 5, 6, 12, 16, 19, 23, 24], "pdf": [3, 4, 5, 11, 23], "per": [2, 12, 21], "perform": [2, 12, 19], "period": 12, "pick": 12, "pip": [9, 19, 24], "place": 15, "pleas": 15, "plot": [4, 5, 11, 19, 24, 25], "plot_spec": [3, 4, 5, 11, 23], "png": [3, 4, 5, 11, 23], "point": [2, 4, 5, 12, 19, 21, 22, 24], "polygon": [4, 5], "posit": [2, 12, 19], "possibli": 10, "post": [21, 25], "potenti": 11, "practic": [14, 19], "pre": [15, 17], "present": [2, 4, 5], "press": 25, "previou": [2, 16], "print": [2, 16, 19], "produc": [2, 4, 5, 10, 11, 16, 19, 21], "product": [5, 12, 18, 19, 23, 25], "program": 23, "project": [7, 8, 14, 19], "properti": [2, 4, 5], "propertynam": [4, 5], "provid": 2, "pull": [9, 15, 17], "push": 5, "pydant": [2, 4, 5], "pypa": 1, "pypi": 19, "python": [7, 15, 19, 23], "python3": 24, "question": 15, "quickli": 23, "quit": 25, "r": [4, 5], "r1": 5, "radiu": [4, 5, 19], "rais": 15, "ram": 12, "rang": [4, 5], "rather": 19, "raw": 2, "read": 23, "reader": 12, "reason": [12, 16], "recalcul": 2, "recommend": [15, 24], "reconstruct": 19, "record": [6, 19], "rectangl": [4, 5], "recurs": [4, 18], "reduc": 15, "ref": [4, 5], "refer": [10, 12, 19], "region": [3, 5, 19], "registri": 17, "regular": 12, "releas": [17, 19, 20, 24], "remain": 15, "reorder": 2, "repeat": [5, 10, 11], "repetit": 2, "repositori": 15, "repr": 18, "repres": 2, "represent": [5, 12], "request": [15, 21, 25], "requir": [2, 4, 5, 12, 24], "reshap": [11, 12], "respons": 21, "rest": [19, 20, 22, 24], "restrict": [2, 5, 19], "result": [11, 23], "return": [2, 4, 5, 10, 21, 25], "returned_fram": 25, "revers": [2, 5, 11], "right": [2, 4, 5], "ring": 5, "rotat": [4, 5], "rout": [2, 10], "row": 16, "run": [2, 5, 11, 14, 15, 16, 19, 22, 24], "sai": 16, "same": [2, 5, 12, 15, 19], "save": 12, "scan": [2, 3, 5, 10, 11, 12, 19, 21, 22, 25], "scanspec": [11, 12, 16, 17, 18, 21, 23, 24, 25], "schema": [2, 4, 5], "scope": 15, "second": [4, 5, 11, 12], "section": 10, "see": [5, 7, 8, 12, 15, 16, 21, 23, 25], "segment": 16, "self": 2, "send": [23, 25], "sens": 12, "seri": [2, 10], "serial": [2, 4, 5, 14, 19, 23], "serializ": [5, 19], "server": 19, "servic": [19, 21, 22, 24], "set": [4, 5, 9, 11, 15, 21, 23], "setpoint": 12, "setup": 9, "setuptools_scm": 1, "sever": 25, "shape": 5, "share": [2, 15], "shot": 16, "should": [2, 5, 9, 10, 12, 16, 23, 24, 25], "show": [4, 5, 18, 23, 25], "shown": 3, "signedinteg": 2, "significantli": 15, "simpl": [16, 23], "simplest": 12, "simpli": 12, "simplifi": 5, "singl": [2, 5, 10, 12, 16], "size": [5, 12, 16, 21], "slower": [2, 11, 12], "slowest": [2, 5, 11, 12], "small": 16, "smallest": 21, "smalleststep": 21, "smalleststeprespons": 21, "snake": [2, 5, 10, 12, 16, 19], "snakedfram": 2, "so": [2, 11, 12, 16, 24], "softwar": 24, "some": [10, 11, 12, 23], "someth": [15, 16], "sourc": [2, 3, 4, 5, 11, 15, 19, 23, 24], "space": [5, 10], "span": [4, 5], "spec": [2, 3, 4, 10, 11, 12, 14, 19, 21, 22], "special": 5, "specif": [5, 16], "specifi": [2, 5, 12, 19], "spend": [5, 15, 19], "spiral": [5, 19], "split": 19, "squash": [2, 5, 6, 19], "squash_fram": 2, "stack": [2, 5, 6, 11, 16, 19], "start": [2, 5, 16, 18, 19, 22, 23, 25], "static": [4, 5], "statu": 21, "step": [5, 14, 16, 19, 21], "stop": [5, 12, 18, 25], "str": [1, 2, 3, 4, 5, 21], "strategi": [11, 12], "strictconfig": 2, "stride": 11, "string": [4, 5], "structur": 7, "subclass": [2, 4, 5], "submodul": 1, "subset": 16, "subtract": 2, "success": 21, "suit": 15, "super_cl": 2, "superclass": 2, "suppli": 2, "support": [4, 5, 11], "sure": 15, "surpris": 11, "swagger": 25, "switch": 9, "symmetricdifferenceof": [4, 5, 23], "system": 23, "t": [2, 12, 15], "take": [11, 12, 16], "taken": [3, 10, 23], "tandem": 5, "task": 15, "technic": [2, 6, 19, 20], "techniqu": 9, "tell": 12, "templat": [7, 15], "term": [2, 6, 19], "termin": [23, 24, 25], "test": 15, "than": [2, 3, 11, 19], "thei": [5, 10, 11, 12], "them": [3, 5, 16, 19, 23], "thi": [2, 4, 5, 7, 8, 9, 10, 15, 16, 18, 23, 24, 25], "those": 25, "three": 10, "through": [2, 3, 5, 10, 11, 15, 16, 19], "throughout": [7, 10], "ticket": 15, "time": [5, 11, 12, 15], "titl": [3, 4, 5], "togeth": [5, 10, 11, 12], "tool": 9, "top": [1, 19], "total_fram": 25, "track": 7, "trajectori": 10, "travers": [2, 12], "true": [2, 4, 5, 16], "tupl": 5, "turn": [12, 18], "turnaround": [3, 5, 16, 23], "tutori": [19, 23, 25], "two": [2, 4, 5, 10, 11, 12, 21, 23], "type": [2, 4, 5, 18, 23, 24, 25], "typevar": 2, "typic": [2, 4, 5, 19, 22], "ui": 25, "unfortun": 11, "union": 2, "unionof": [4, 5, 23], "unpack": 16, "unprocess": 21, "unsquash": 11, "until": 12, "up": [2, 10, 15, 25], "updat": [2, 9], "upper": [2, 5, 10, 12, 16, 19, 21, 23], "us": [2, 3, 5, 8, 9, 10, 12, 15, 16, 17, 18, 19, 23, 24, 25], "usag": [19, 22], "user": [11, 14, 19, 22], "util": 25, "valid": 21, "validrespons": 21, "valu": [2, 4, 5], "valueerror": 11, "variabl": [2, 23], "vd": [11, 12], "vector": 10, "venv": [9, 24], "veri": 16, "version": [1, 2, 11, 17, 21], "vert": [4, 5], "vertic": [4, 5], "viabl": 21, "view": 16, "visual": 3, "vscode": 15, "wa": [10, 15, 18], "wai": [2, 6, 7, 16, 19], "want": [5, 15, 23, 25], "we": [7, 8, 9, 11, 12, 15, 16, 18, 23, 25], "web": 25, "welcom": 15, "wether": 21, "what": [5, 23], "when": [2, 5, 11, 12, 15, 16, 19], "where": [2, 11, 16, 23], "whether": [2, 21], "which": [2, 4, 11, 12, 19, 25], "while": [10, 15], "whole": 10, "why": [2, 5, 6, 10, 16, 19], "width": 5, "within": [2, 4, 5, 10, 11, 23], "won": 12, "work": [6, 16, 19], "would": [10, 11, 12, 23, 25], "wrap": 5, "wrapper": 16, "write": [11, 12], "written": 12, "x": [2, 3, 4, 5, 10, 11, 12, 16, 18, 19, 23, 25], "x_axi": [4, 5], "x_max": [4, 5], "x_middl": [4, 5], "x_min": [4, 5], "x_radiu": [4, 5], "x_rang": 5, "x_start": 5, "x_vert": [4, 5], "xmotor": 2, "xy": [4, 5], "y": [2, 3, 4, 5, 11, 12, 16, 18, 19, 23, 25], "y_axi": [4, 5], "y_max": [4, 5], "y_middl": [4, 5], "y_min": [4, 5], "y_radiu": [4, 5], "y_rang": 5, "y_start": 5, "y_vert": [4, 5], "yield": 4, "ymotor": 2, "you": [5, 12, 15, 23, 24, 25], "your": 15, "z": [3, 5, 11, 23], "zip": [2, 5, 19, 23]}, "titles": ["API", "scanspec", "scanspec.core", "scanspec.plot", "scanspec.regions", "scanspec.specs", "Explanations", "Architectural Decision Records", "1. Record architecture decisions", "2. Adopt python-copier-template for project structure", "Technical Terms", "Why Squash (and Mask) can change the Path", "Why create a stack of Frames?", "Index", "How-to Guides", "Contribute to the project", "How to Iterate a Spec", "Run in a container", "How to Serialize and Deserialize a Spec", "scanspec", "Reference", "REST API", "Tutorials", "Creating a Scan Spec", "Installation", "Running a REST service for generating points"], "titleterms": {"1": 8, "2": [9, 23], "If": 16, "about": 12, "adopt": 9, "an": 12, "api": [0, 21], "architectur": [7, 8], "ax": 23, "axi": [10, 11], "between": 16, "can": 11, "chang": 11, "check": 24, "code": 15, "commandlin": 23, "conclus": 23, "consequ": [8, 9], "contain": 17, "context": [8, 9], "contribut": 15, "copier": 9, "core": 2, "coverag": 15, "creat": [12, 23, 24], "decis": [7, 8, 9], "deseri": 18, "develop": 15, "dimens": 12, "discuss": 15, "do": 16, "document": 19, "doe": 12, "environ": 24, "exampl": 12, "explan": 6, "flat": 12, "fly": 16, "frame": [10, 11, 12], "from": 23, "gap": 16, "gener": 25, "grid": 23, "guid": 14, "hdf5": 12, "how": [12, 14, 16, 18, 19], "i": [16, 19], "index": 13, "inform": 15, "instal": 24, "issu": 15, "iter": 16, "know": 16, "length": 11, "librari": 24, "line": 23, "mask": [11, 23], "matter": 11, "midpoint": [16, 25], "most": 16, "multipl": 23, "need": 16, "odd": 11, "onli": 16, "option": 16, "path": [10, 11], "perform": 16, "plot": [3, 23], "point": [10, 16, 25], "project": [9, 15], "python": [9, 24], "record": [7, 8], "refer": 20, "region": [4, 12, 23], "relat": 12, "rest": [21, 25], "run": [17, 25], "scan": [16, 23], "scanspec": [1, 2, 3, 4, 5, 19], "sequenc": 12, "serial": 18, "server": 25, "servic": 25, "snake": [11, 23], "spec": [5, 16, 18, 23, 25], "squash": [11, 12], "stack": [10, 12], "start": 17, "statu": [8, 9], "structur": [9, 19], "technic": 10, "templat": 9, "term": 10, "them": 12, "thi": [11, 12], "tutori": 22, "unsnak": 11, "valid": 25, "version": 24, "virtual": 24, "want": 16, "what": 12, "whether": 16, "why": [11, 12], "you": 16, "your": 24}}) \ No newline at end of file diff --git a/main/tutorials.html b/main/tutorials.html index 02d41fe8..47f88195 100644 --- a/main/tutorials.html +++ b/main/tutorials.html @@ -8,7 +8,7 @@ - Tutorials — scanspec 0.7.4.dev1+g4deecf8b documentation + Tutorials — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/tutorials/creating-a-spec.html b/main/tutorials/creating-a-spec.html index be5a4640..3eed740f 100644 --- a/main/tutorials/creating-a-spec.html +++ b/main/tutorials/creating-a-spec.html @@ -8,7 +8,7 @@ - Creating a Scan Spec — scanspec 0.7.4.dev1+g4deecf8b documentation + Creating a Scan Spec — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/tutorials/installation.html b/main/tutorials/installation.html index b5733503..07c08d51 100644 --- a/main/tutorials/installation.html +++ b/main/tutorials/installation.html @@ -8,7 +8,7 @@ - Installation — scanspec 0.7.4.dev1+g4deecf8b documentation + Installation — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + + diff --git a/main/tutorials/rest-service.html b/main/tutorials/rest-service.html index e5fc8229..b9660920 100644 --- a/main/tutorials/rest-service.html +++ b/main/tutorials/rest-service.html @@ -8,7 +8,7 @@ - Running a REST service for generating points — scanspec 0.7.4.dev1+g4deecf8b documentation + Running a REST service for generating points — scanspec 0.7.5.dev2+g6291ec72 documentation @@ -30,7 +30,7 @@ - + @@ -40,8 +40,8 @@ - - + +