diff --git a/.buildinfo b/.buildinfo index 31b41d6..dc351cc 100644 --- a/.buildinfo +++ b/.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: ee1706def11a0152024844a698af8a00 +config: cdbb56ae19bd0e35b18559a93b4f3e53 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/bioio_nd2.doctree b/.doctrees/bioio_nd2.doctree index b138aaa..f90910f 100644 Binary files a/.doctrees/bioio_nd2.doctree and b/.doctrees/bioio_nd2.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index cc9e2ed..5077695 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/_modules/bioio_nd2/reader.html b/_modules/bioio_nd2/reader.html index 2cf2517..e98967a 100644 --- a/_modules/bioio_nd2/reader.html +++ b/_modules/bioio_nd2/reader.html @@ -4,8 +4,8 @@ - - bioio_nd2.reader - bioio-nd2 0.1.dev1+g87334b5 documentation + + bioio_nd2.reader - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -123,7 +123,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -146,7 +146,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation
+
diff --git a/_modules/bioio_nd2/reader_metadata.html b/_modules/bioio_nd2/reader_metadata.html index 6c04987..df5e74e 100644 --- a/_modules/bioio_nd2/reader_metadata.html +++ b/_modules/bioio_nd2/reader_metadata.html @@ -4,8 +4,8 @@ - - bioio_nd2.reader_metadata - bioio-nd2 0.1.dev1+g87334b5 documentation + + bioio_nd2.reader_metadata - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -123,7 +123,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -146,7 +146,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -271,7 +271,7 @@

Source code for bioio_nd2.reader_metadata
-
+
diff --git a/_modules/index.html b/_modules/index.html index 19b19a6..8f9e79f 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -4,8 +4,8 @@ - - Overview: module code - bioio-nd2 0.1.dev1+g87334b5 documentation + + Overview: module code - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -123,7 +123,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -146,7 +146,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -231,7 +231,7 @@

All modules for which code is available

-
+
diff --git a/_static/documentation_options.js b/_static/documentation_options.js index eb27c74..dddb900 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.1.dev1+g87334b5', + VERSION: '0.1.dev1+gba148f7', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/bioio_nd2.html b/bioio_nd2.html index debd7bf..c0d3ed1 100644 --- a/bioio_nd2.html +++ b/bioio_nd2.html @@ -5,8 +5,8 @@ - - bioio_nd2 package - bioio-nd2 0.1.dev1+g87334b5 documentation + + bioio_nd2 package - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -124,7 +124,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -147,7 +147,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -203,9 +203,9 @@

bioio_nd2 package

Submodules#

-
-

bioio_nd2.reader module#

-
+
+

bioio_nd2.reader module#

+
class bioio_nd2.reader.Reader(image: str | Path, fs_kwargs: Dict[str, Any] = {})[source]#

Bases: Reader

@@ -271,9 +271,9 @@

bioio_nd2.reader module

-
-

bioio_nd2.reader_metadata module#

-
+
+

bioio_nd2.reader_metadata module#

+
class bioio_nd2.reader_metadata.ReaderMetadata[source]#

Bases: ReaderMetadata

@@ -295,9 +295,9 @@

bioio_nd2.reader_metadata module -

Module contents#

-

Top-level package for bioio_nd2.

+
+

Module contents#

+

Top-level package for bioio_nd2.

class bioio_nd2.Reader(image: str | Path, fs_kwargs: Dict[str, Any] = {})[source]#
@@ -444,7 +444,7 @@

Module contentsbioio_nd2 package

diff --git a/contributing.html b/contributing.html index d657ebd..c69a2eb 100644 --- a/contributing.html +++ b/contributing.html @@ -5,8 +5,8 @@ - - Contributing - bioio-nd2 0.1.dev1+g87334b5 documentation + + Contributing - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -124,7 +124,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -147,7 +147,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -348,7 +348,7 @@

Deploying +

diff --git a/genindex.html b/genindex.html index cb21952..8aaa208 100644 --- a/genindex.html +++ b/genindex.html @@ -4,7 +4,7 @@ - Index - bioio-nd2 0.1.dev1+g87334b5 documentation + Index - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -122,7 +122,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -145,7 +145,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -354,7 +354,7 @@

S

-
+
diff --git a/index.html b/index.html index ecdbb2d..2294665 100644 --- a/index.html +++ b/index.html @@ -5,8 +5,8 @@ - - bioio-nd2 0.1.dev1+g87334b5 documentation + + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -124,7 +124,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -147,7 +147,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -275,7 +275,7 @@

Development +

diff --git a/installation.html b/installation.html index eed2215..ccc9ef4 100644 --- a/installation.html +++ b/installation.html @@ -5,8 +5,8 @@ - - Installation - bioio-nd2 0.1.dev1+g87334b5 documentation + + Installation - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -124,7 +124,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -147,7 +147,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -297,7 +297,7 @@

From sources +

diff --git a/modules.html b/modules.html index 70fe7a5..a6afb0f 100644 --- a/modules.html +++ b/modules.html @@ -5,8 +5,8 @@ - - bioio_nd2 - bioio-nd2 0.1.dev1+g87334b5 documentation + + bioio_nd2 - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -124,7 +124,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -147,7 +147,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -204,7 +204,7 @@

bioio_nd2bioio_nd2 package

diff --git a/objects.inv b/objects.inv index 363b012..47d5158 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html index 06daa26..fb93260 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - bioio-nd2 0.1.dev1+g87334b5 documentation + Python Module Index - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -122,7 +122,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -145,7 +145,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -259,7 +259,7 @@

Python Module Index

-
+
diff --git a/search.html b/search.html index 3c0a74e..bc6bdfc 100644 --- a/search.html +++ b/search.html @@ -4,7 +4,7 @@ - Search - bioio-nd2 0.1.dev1+g87334b5 documentation + Search - bioio-nd2 0.1.dev1+gba148f7 documentation @@ -121,7 +121,7 @@
-
bioio-nd2 0.1.dev1+g87334b5 documentation
 +
bioio-nd2 0.1.dev1+gba148f7 documentation
@@ -144,7 +144,7 @@
- bioio-nd2 0.1.dev1+g87334b5 documentation + bioio-nd2 0.1.dev1+gba148f7 documentation @@ -237,7 +237,7 @@
-
+
diff --git a/searchindex.js b/searchindex.js index 3238198..5f6aee6 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["bioio_nd2", "contributing", "index", "installation", "modules"], "filenames": ["bioio_nd2.rst", "contributing.rst", "index.rst", "installation.rst", "modules.rst"], "titles": ["bioio_nd2 package", "Contributing", "Welcome to bioio-nd2\u2019s documentation!", "Installation", "bioio_nd2"], "terms": {"class": 0, "imag": [0, 2], "str": 0, "path": 0, "fs_kwarg": 0, "dict": 0, "ani": [0, 1], "sourc": 0, "base": 0, "read": [0, 1, 2], "ni": 0, "element": 0, "file": [0, 1], "us": [0, 1], "nikon": 0, "nd2": [0, 1, 3], "sdk": 0, "thi": [0, 1, 3], "requir": 0, "instal": 0, "environ": [0, 1], "paramet": 0, "specif": 0, "keyword": 0, "argument": 0, "pass": [0, 1], "down": 0, "fsspec": 0, "creat": [0, 1], "filesystem": 0, "default": [0, 1], "rais": 0, "except": 0, "unsupportedfileformaterror": 0, "If": [0, 1, 3], "i": [0, 1, 3], "support": 0, "properti": 0, "physical_pixel_s": [0, 4], "physicalpixels": 0, "return": 0, "size": 0, "avail": [0, 1], "metadata": [0, 1], "float": 0, "repres": 0, "physic": 0, "pixel": 0, "dimens": 0, "z": [0, 1], "y": [0, 1], "x": 0, "note": 0, "we": [0, 1], "current": 0, "do": 0, "handl": [0, 1], "unit": 0, "attach": 0, "valu": 0, "pleas": [0, 1, 2], "see": [0, 1, 2], "inform": [0, 2], "scene": [0, 4], "tupl": 0, "A": [0, 1, 2], "valid": 0, "id": 0, "ar": [0, 1], "string": 0, "rang": 0, "integ": 0, "when": [0, 1], "iter": 0, "over": 0, "len": 0, "readermetadata": [0, 4], "defin": 0, "itself": 0, "extens": 0, "static": 0, "get_read": [0, 4], "plugin": 0, "get_supported_extens": [0, 4], "list": [0, 1], "top": 0, "level": 0, "welcom": 1, "thei": 1, "greatli": 1, "appreci": 1, "everi": 1, "littl": 1, "bit": 1, "help": 1, "credit": 1, "alwai": [1, 3], "given": 1, "someth": 1, "goe": 1, "wrong": 1, "point": 1, "dure": 1, "librari": 1, "how": 1, "our": 1, "ci": 1, "cd": 1, "github": [1, 2, 3], "action": 1, "build": 1, "project": 1, "most": [1, 3], "up": 1, "date": 1, "readi": 1, "here": 1, "": 1, "set": 1, "bioio": [1, 3], "local": 1, "fork": 1, "repo": [1, 3], "clone": [1, 3], "your": [1, 3], "git": [1, 2, 3], "com": [1, 2, 3], "your_name_her": 1, "edit": 1, "mode": 1, "It": 1, "also": 1, "recommend": 1, "work": 1, "virtualenv": 1, "anaconda": 1, "setup": [1, 3], "dev": [1, 2, 3], "branch": 1, "checkout": 1, "b": 1, "your_development_typ": 1, "short": 1, "descript": 1, "ex": 1, "featur": 1, "tiff": 1, "bugfix": 1, "found": 1, "raw": 1, "html": 1, "m2r": 1, "br": 1, "now": 1, "you": [1, 3], "can": [1, 3], "make": 1, "chang": 1, "re": 1, "done": 1, "check": 1, "lint": 1, "test": 1, "commit": 1, "push": 1, "add": 1, "m": 1, "detail": 1, "origin": 1, "submit": 1, "pull": 1, "request": 1, "through": [1, 3], "websit": 1, "For": [1, 2], "recip": 1, "run": [1, 3], "clean": 1, "all": 1, "python": [1, 3], "gener": 1, "doc": 1, "sphinx": 1, "document": 1, "dep": 1, "format": 1, "releas": [1, 2], "new": 1, "version": 1, "serv": 1, "browser": 1, "tag": 1, "updat": 1, "from": [1, 2], "cookiecutt": 1, "latest": 1, "reader": [1, 2, 4], "remind": 1, "maintain": 1, "sure": 1, "main": [1, 3], "out": 1, "desir": 1, "merg": 1, "Then": 1, "vx": 1, "The": [1, 3], "presenc": 1, "v": 1, "trigger": 1, "publish": 1, "step": 1, "workflow": 1, "which": 1, "packag": [1, 2, 4], "upload": 1, "pypi": 1, "inject": 1, "setuptool": 1, "scm": 1, "http": [1, 2, 3], "pypa": 1, "setuptools_scm": 1, "_": 1, "stabl": 2, "pip": [2, 3], "head": 2, "bioio_nd2": 2, "import": 2, "r": 2, "my": 2, "ext": 2, "dim": 2, "full": 2, "visit": 2, "io": 2, "contribut": 2, "md": 2, "relat": 2, "code": 2, "mit": 2, "licens": 2, "To": 3, "command": 3, "termin": 3, "prefer": 3, "method": 3, "recent": 3, "don": 3, "t": 3, "have": 3, "guid": 3, "process": 3, "download": 3, "either": 3, "public": 3, "repositori": 3, "Or": 3, "tarbal": 3, "curl": 3, "ol": 3, "onc": 3, "copi": 3, "py": 3, "submodul": 4, "modul": 4, "reader_metadata": 4, "content": 4}, "objects": {"": [[0, 0, 0, "-", "bioio_nd2"]], "bioio_nd2": [[0, 1, 1, "", "Reader"], [0, 1, 1, "", "ReaderMetadata"], [0, 0, 0, "-", "reader"], [0, 0, 0, "-", "reader_metadata"]], "bioio_nd2.Reader": [[0, 2, 1, "", "physical_pixel_sizes"], [0, 2, 1, "", "scenes"]], "bioio_nd2.ReaderMetadata": [[0, 3, 1, "", "get_reader"], [0, 3, 1, "", "get_supported_extensions"]], "bioio_nd2.reader": [[0, 1, 1, "", "Reader"]], "bioio_nd2.reader.Reader": [[0, 2, 1, "", "physical_pixel_sizes"], [0, 2, 1, "", "scenes"]], "bioio_nd2.reader_metadata": [[0, 1, 1, "", "ReaderMetadata"]], "bioio_nd2.reader_metadata.ReaderMetadata": [[0, 3, 1, "", "get_reader"], [0, 3, 1, "", "get_supported_extensions"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:property", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "property", "Python property"], "3": ["py", "method", "Python method"]}, "titleterms": {"bioio_nd2": [0, 4], "packag": 0, "submodul": 0, "reader": 0, "modul": 0, "reader_metadata": 0, "content": 0, "contribut": 1, "develop": [1, 2], "instal": [1, 2, 3], "get": 1, "start": 1, "just": 1, "command": 1, "deploi": 1, "welcom": 2, "bioio": 2, "nd2": 2, "": 2, "document": 2, "thi": 2, "plugin": 2, "i": 2, "intend": 2, "us": 2, "conjunct": 2, "quickstart": 2, "stabl": 3, "releas": 3, "from": 3, "sourc": 3}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"bioio_nd2 package": [[0, "bioio-nd2-package"]], "Submodules": [[0, "submodules"]], "bioio_nd2.reader module": [[0, "bioio-nd2-reader-module"]], "bioio_nd2.reader_metadata module": [[0, "bioio-nd2-reader-metadata-module"]], "Module contents": [[0, "module-contents"]], "Contributing": [[1, "contributing"]], "Developer Installation": [[1, "developer-installation"]], "Get Started!": [[1, "get-started"]], "Just Commands": [[1, "just-commands"]], "Deploying": [[1, "deploying"]], "Welcome to bioio-nd2\u2019s documentation!": [[2, "welcome-to-bioio-nd2-s-documentation"]], "bioio-nd2": [[2, "bioio-nd2"]], "This plugin is intended to be used in conjunction with bioio": [[2, "this-plugin-is-intended-to-be-used-in-conjunction-with-bioio"]], "Installation": [[2, "installation"], [3, "installation"]], "Quickstart": [[2, "quickstart"]], "Documentation": [[2, "documentation"]], "Development": [[2, "development"]], "Stable release": [[3, "stable-release"]], "From sources": [[3, "from-sources"]], "bioio_nd2": [[4, "bioio-nd2"]]}, "indexentries": {"reader (class in bioio_nd2)": [[0, "bioio_nd2.Reader"]], "reader (class in bioio_nd2.reader)": [[0, "bioio_nd2.reader.Reader"]], "readermetadata (class in bioio_nd2)": [[0, "bioio_nd2.ReaderMetadata"]], "readermetadata (class in bioio_nd2.reader_metadata)": [[0, "bioio_nd2.reader_metadata.ReaderMetadata"]], "bioio_nd2": [[0, "module-bioio_nd2"]], "bioio_nd2.reader": [[0, "module-bioio_nd2.reader"]], "bioio_nd2.reader_metadata": [[0, "module-bioio_nd2.reader_metadata"]], "get_reader() (bioio_nd2.readermetadata static method)": [[0, "bioio_nd2.ReaderMetadata.get_reader"]], "get_reader() (bioio_nd2.reader_metadata.readermetadata static method)": [[0, "bioio_nd2.reader_metadata.ReaderMetadata.get_reader"]], "get_supported_extensions() (bioio_nd2.readermetadata static method)": [[0, "bioio_nd2.ReaderMetadata.get_supported_extensions"]], "get_supported_extensions() (bioio_nd2.reader_metadata.readermetadata static method)": [[0, "bioio_nd2.reader_metadata.ReaderMetadata.get_supported_extensions"]], "module": [[0, "module-bioio_nd2"], [0, "module-bioio_nd2.reader"], [0, "module-bioio_nd2.reader_metadata"]], "physical_pixel_sizes (bioio_nd2.reader property)": [[0, "bioio_nd2.Reader.physical_pixel_sizes"]], "physical_pixel_sizes (bioio_nd2.reader.reader property)": [[0, "bioio_nd2.reader.Reader.physical_pixel_sizes"]], "scenes (bioio_nd2.reader property)": [[0, "bioio_nd2.Reader.scenes"]], "scenes (bioio_nd2.reader.reader property)": [[0, "bioio_nd2.reader.Reader.scenes"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["bioio_nd2", "contributing", "index", "installation", "modules"], "filenames": ["bioio_nd2.rst", "contributing.rst", "index.rst", "installation.rst", "modules.rst"], "titles": ["bioio_nd2 package", "Contributing", "Welcome to bioio-nd2\u2019s documentation!", "Installation", "bioio_nd2"], "terms": {"class": 0, "imag": [0, 2], "str": 0, "path": 0, "fs_kwarg": 0, "dict": 0, "ani": [0, 1], "sourc": 0, "base": 0, "read": [0, 1, 2], "ni": 0, "element": 0, "file": [0, 1], "us": [0, 1], "nikon": 0, "nd2": [0, 1, 3], "sdk": 0, "thi": [0, 1, 3], "requir": 0, "instal": 0, "environ": [0, 1], "paramet": 0, "specif": 0, "keyword": 0, "argument": 0, "pass": [0, 1], "down": 0, "fsspec": 0, "creat": [0, 1], "filesystem": 0, "default": [0, 1], "rais": 0, "except": 0, "unsupportedfileformaterror": 0, "If": [0, 1, 3], "i": [0, 1, 3], "support": 0, "properti": 0, "physical_pixel_s": [0, 4], "physicalpixels": 0, "return": 0, "size": 0, "avail": [0, 1], "metadata": [0, 1], "float": 0, "repres": 0, "physic": 0, "pixel": 0, "dimens": 0, "z": [0, 1], "y": [0, 1], "x": 0, "note": 0, "we": [0, 1], "current": 0, "do": 0, "handl": [0, 1], "unit": 0, "attach": 0, "valu": 0, "pleas": [0, 1, 2], "see": [0, 1, 2], "inform": [0, 2], "scene": [0, 4], "tupl": 0, "A": [0, 1, 2], "valid": 0, "id": 0, "ar": [0, 1], "string": 0, "rang": 0, "integ": 0, "when": [0, 1], "iter": 0, "over": 0, "len": 0, "readermetadata": [0, 4], "defin": 0, "itself": 0, "extens": 0, "static": 0, "get_read": [0, 4], "plugin": 0, "get_supported_extens": [0, 4], "list": [0, 1], "top": 0, "level": 0, "welcom": 1, "thei": 1, "greatli": 1, "appreci": 1, "everi": 1, "littl": 1, "bit": 1, "help": 1, "credit": 1, "alwai": [1, 3], "given": 1, "someth": 1, "goe": 1, "wrong": 1, "point": 1, "dure": 1, "librari": 1, "how": 1, "our": 1, "ci": 1, "cd": 1, "github": [1, 2, 3], "action": 1, "build": 1, "project": 1, "most": [1, 3], "up": 1, "date": 1, "readi": 1, "here": 1, "": 1, "set": 1, "bioio": [1, 3], "local": 1, "fork": 1, "repo": [1, 3], "clone": [1, 3], "your": [1, 3], "git": [1, 2, 3], "com": [1, 2, 3], "your_name_her": 1, "edit": 1, "mode": 1, "It": 1, "also": 1, "recommend": 1, "work": 1, "virtualenv": 1, "anaconda": 1, "setup": [1, 3], "dev": [1, 2, 3], "branch": 1, "checkout": 1, "b": 1, "your_development_typ": 1, "short": 1, "descript": 1, "ex": 1, "featur": 1, "tiff": 1, "bugfix": 1, "found": 1, "raw": 1, "html": 1, "m2r": 1, "br": 1, "now": 1, "you": [1, 3], "can": [1, 3], "make": 1, "chang": 1, "re": 1, "done": 1, "check": 1, "lint": 1, "test": 1, "commit": 1, "push": 1, "add": 1, "m": 1, "detail": 1, "origin": 1, "submit": 1, "pull": 1, "request": 1, "through": [1, 3], "websit": 1, "For": [1, 2], "recip": 1, "run": [1, 3], "clean": 1, "all": 1, "python": [1, 3], "gener": 1, "doc": 1, "sphinx": 1, "document": 1, "dep": 1, "format": 1, "releas": [1, 2], "new": 1, "version": 1, "serv": 1, "browser": 1, "tag": 1, "updat": 1, "from": [1, 2], "cookiecutt": 1, "latest": 1, "reader": [1, 2, 4], "remind": 1, "maintain": 1, "sure": 1, "main": [1, 3], "out": 1, "desir": 1, "merg": 1, "Then": 1, "vx": 1, "The": [1, 3], "presenc": 1, "v": 1, "trigger": 1, "publish": 1, "step": 1, "workflow": 1, "which": 1, "packag": [1, 2, 4], "upload": 1, "pypi": 1, "inject": 1, "setuptool": 1, "scm": 1, "http": [1, 2, 3], "pypa": 1, "setuptools_scm": 1, "_": 1, "stabl": 2, "pip": [2, 3], "head": 2, "bioio_nd2": 2, "import": 2, "r": 2, "my": 2, "ext": 2, "dim": 2, "full": 2, "visit": 2, "io": 2, "contribut": 2, "md": 2, "relat": 2, "code": 2, "mit": 2, "licens": 2, "To": 3, "command": 3, "termin": 3, "prefer": 3, "method": 3, "recent": 3, "don": 3, "t": 3, "have": 3, "guid": 3, "process": 3, "download": 3, "either": 3, "public": 3, "repositori": 3, "Or": 3, "tarbal": 3, "curl": 3, "ol": 3, "onc": 3, "copi": 3, "py": 3, "submodul": 4, "modul": 4, "reader_metadata": 4, "content": 4}, "objects": {"": [[0, 0, 0, "-", "bioio_nd2"]], "bioio_nd2": [[0, 1, 1, "", "Reader"], [0, 1, 1, "", "ReaderMetadata"], [0, 0, 0, "-", "reader"], [0, 0, 0, "-", "reader_metadata"]], "bioio_nd2.Reader": [[0, 2, 1, "", "physical_pixel_sizes"], [0, 2, 1, "", "scenes"]], "bioio_nd2.ReaderMetadata": [[0, 3, 1, "", "get_reader"], [0, 3, 1, "", "get_supported_extensions"]], "bioio_nd2.reader": [[0, 1, 1, "", "Reader"]], "bioio_nd2.reader.Reader": [[0, 2, 1, "", "physical_pixel_sizes"], [0, 2, 1, "", "scenes"]], "bioio_nd2.reader_metadata": [[0, 1, 1, "", "ReaderMetadata"]], "bioio_nd2.reader_metadata.ReaderMetadata": [[0, 3, 1, "", "get_reader"], [0, 3, 1, "", "get_supported_extensions"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:property", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "property", "Python property"], "3": ["py", "method", "Python method"]}, "titleterms": {"bioio_nd2": [0, 4], "packag": 0, "submodul": 0, "reader": 0, "modul": 0, "reader_metadata": 0, "content": 0, "contribut": 1, "develop": [1, 2], "instal": [1, 2, 3], "get": 1, "start": 1, "just": 1, "command": 1, "deploi": 1, "welcom": 2, "bioio": 2, "nd2": 2, "": 2, "document": 2, "thi": 2, "plugin": 2, "i": 2, "intend": 2, "us": 2, "conjunct": 2, "quickstart": 2, "stabl": 3, "releas": 3, "from": 3, "sourc": 3}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"bioio_nd2 package": [[0, "bioio-nd2-package"]], "Submodules": [[0, "submodules"]], "bioio_nd2.reader module": [[0, "module-bioio_nd2.reader"]], "bioio_nd2.reader_metadata module": [[0, "module-bioio_nd2.reader_metadata"]], "Module contents": [[0, "module-bioio_nd2"]], "Contributing": [[1, "contributing"]], "Developer Installation": [[1, "developer-installation"]], "Get Started!": [[1, "get-started"]], "Just Commands": [[1, "just-commands"]], "Deploying": [[1, "deploying"]], "Welcome to bioio-nd2\u2019s documentation!": [[2, "welcome-to-bioio-nd2-s-documentation"]], "bioio-nd2": [[2, "bioio-nd2"]], "This plugin is intended to be used in conjunction with bioio": [[2, "this-plugin-is-intended-to-be-used-in-conjunction-with-bioio"]], "Installation": [[2, "installation"], [3, "installation"]], "Quickstart": [[2, "quickstart"]], "Documentation": [[2, "documentation"]], "Development": [[2, "development"]], "Stable release": [[3, "stable-release"]], "From sources": [[3, "from-sources"]], "bioio_nd2": [[4, "bioio-nd2"]]}, "indexentries": {"reader (class in bioio_nd2)": [[0, "bioio_nd2.Reader"]], "reader (class in bioio_nd2.reader)": [[0, "bioio_nd2.reader.Reader"]], "readermetadata (class in bioio_nd2)": [[0, "bioio_nd2.ReaderMetadata"]], "readermetadata (class in bioio_nd2.reader_metadata)": [[0, "bioio_nd2.reader_metadata.ReaderMetadata"]], "bioio_nd2": [[0, "module-bioio_nd2"]], "bioio_nd2.reader": [[0, "module-bioio_nd2.reader"]], "bioio_nd2.reader_metadata": [[0, "module-bioio_nd2.reader_metadata"]], "get_reader() (bioio_nd2.readermetadata static method)": [[0, "bioio_nd2.ReaderMetadata.get_reader"]], "get_reader() (bioio_nd2.reader_metadata.readermetadata static method)": [[0, "bioio_nd2.reader_metadata.ReaderMetadata.get_reader"]], "get_supported_extensions() (bioio_nd2.readermetadata static method)": [[0, "bioio_nd2.ReaderMetadata.get_supported_extensions"]], "get_supported_extensions() (bioio_nd2.reader_metadata.readermetadata static method)": [[0, "bioio_nd2.reader_metadata.ReaderMetadata.get_supported_extensions"]], "module": [[0, "module-bioio_nd2"], [0, "module-bioio_nd2.reader"], [0, "module-bioio_nd2.reader_metadata"]], "physical_pixel_sizes (bioio_nd2.reader property)": [[0, "bioio_nd2.Reader.physical_pixel_sizes"]], "physical_pixel_sizes (bioio_nd2.reader.reader property)": [[0, "bioio_nd2.reader.Reader.physical_pixel_sizes"]], "scenes (bioio_nd2.reader property)": [[0, "bioio_nd2.Reader.scenes"]], "scenes (bioio_nd2.reader.reader property)": [[0, "bioio_nd2.reader.Reader.scenes"]]}}) \ No newline at end of file