Search.setIndex({"docnames": ["index", "osirispy", "usage"], "filenames": ["index.rst", "osirispy.rst", "usage.rst"], "titles": ["Welcome to osirispy\u2019s documentation!", "osirispy module", "Examples/Usage"], "terms": {"i": [0, 1, 2], "python": [0, 2], "packag": [0, 2], "read": [0, 1, 2], "simul": 0, "output": [0, 1, 2], "particl": [0, 1], "cell": 0, "code": 0, "osiri": [0, 1, 2], "It": [0, 2], "util": 0, "numpi": [0, 2], "interfac": 0, "provid": 0, "simpl": 0, "wai": 0, "avail": [0, 1], "pypi": 0, "you": [0, 2], "can": [0, 2], "run": 0, "follow": 0, "command": 0, "insid": 0, "your": 0, "termin": 0, "pip3": 0, "osirispi": 2, "modul": [], "method": [], "class": [], "os_data": 1, "datatyp": 1, "grid": 1, "__init__": 1, "axi": [1, 2], "raw": 1, "track": 1, "fname": 1, "req_quant": [1, 2], "x1": [1, 2], "x2": [1, 2], "sourc": 1, "an": [1, 2], "data": [1, 2], "file": 1, "paramet": [1, 2], "str": 1, "The": [1, 2], "path": [1, 2], "tupl": 1, "option": 1, "quantiti": [1, 2], "requir": [1, 2], "when": [1, 2], "default": 1, "return": 1, "object": [1, 2], "type": [1, 2], "base": [1, 2], "A": 1, "repres": [1, 2], "gener": 1, "our": 1, "properti": 1, "us": [1, 2], "dim": 1, "int": 1, "format": 1, "string": [1, 2], "print": 1, "out": 1, "what": 1, "anim": 1, "sai": 1, "list": [1, 2], "conta": 1, "spatial": 1, "limit": 1, "np": 1, "arrai": [1, 2], "label": [1, 2], "time_": 1, "float": 1, "timestamp": 1, "construct": 1, "all": 1, "necessari": 1, "attribut": 1, "nx": 1, "lim": 1, "param": 1, "number": 1, "point": 1, "along": 1, "ax_arr": 1, "contain": [1, 2], "poin": 1, "dict": 1, "dictionari": [1, 2], "load": 1, "whose": 1, "kei": 1, "ar": [1, 2], "requeir": 1, "rais": 1, "keyerror": 1, "If": 1, "each": [1, 2], "import": 2, "ospi": 2, "function": 2, "give": 2, "differ": 2, "being": 2, "open": 2, "vdf": 2, "have": 2, "between": 2, "1": 2, "3": 2, "dimens": 2, "thei": 2, "charg": 2, "densiti": 2, "current": 2, "e": 2, "m": 2, "field": 2, "phasespac": 2, "etc": 2, "access": 2, "griddata": 2, "h5": 2, "also": 2, "physic": 2, "diment": 2, "diagnost": 2, "given": 2, "speci": 2, "time": 2, "step": 2, "inform": 2, "x3": 2, "p1": 2, "p2": 2, "p3": 2, "en": 2, "specifi": 2, "rawdata": 2, "below": 2, "t": 2, "trackdata": 2}, "objects": {"osirispy": [[1, 0, 1, "", "axis"], [1, 0, 1, "", "grid"], [1, 0, 1, "", "os_data"], [1, 0, 1, "", "raw"], [1, 3, 1, "", "read"], [1, 0, 1, "", "track"]], "osirispy.axis": [[1, 1, 1, "", "__init__"]], "osirispy.grid": [[1, 1, 1, "", "__init__"]], "osirispy.os_data": [[1, 2, 1, "", "datatype"]], "osirispy.raw": [[1, 1, 1, "", "__init__"]], "osirispy.track": [[1, 1, 1, "", "__init__"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:property", "3": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "property", "Python property"], "3": ["py", "function", "Python function"]}, "titleterms": {"welcom": 0, "osirispi": [0, 1], "": 0, "document": 0, "introduct": 0, "instal": 0, "modul": 1, "method": 1, "class": 1, "exampl": 2, "usag": 2, "grid": 2, "file": 2, "particl": 2, "aka": 2, "raw": 2, "track": 2}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"Welcome to osirispy\u2019s documentation!": [[0, "welcome-to-osirispy-s-documentation"]], "Introduction": [[0, "introduction"]], "Installation": [[0, "installation"]], "osirispy module": [[1, "osirispy-module"]], "Module methods": [[1, "module-methods"]], "Module classes": [[1, "module-classes"]], "Examples/Usage": [[2, "examples-usage"]], "Grid files": [[2, "grid-files"]], "Particle (aka RAW) files": [[2, "particle-aka-raw-files"]], "Track  files": [[2, "track-files"]]}, "indexentries": {"__init__() (osirispy.axis method)": [[1, "osirispy.axis.__init__"]], "__init__() (osirispy.grid method)": [[1, "osirispy.grid.__init__"]], "__init__() (osirispy.raw method)": [[1, "osirispy.raw.__init__"]], "__init__() (osirispy.track method)": [[1, "osirispy.track.__init__"]], "axis (class in osirispy)": [[1, "osirispy.axis"]], "datatype (osirispy.os_data property)": [[1, "osirispy.os_data.datatype"]], "grid (class in osirispy)": [[1, "osirispy.grid"]], "os_data (class in osirispy)": [[1, "osirispy.os_data"]], "raw (class in osirispy)": [[1, "osirispy.raw"]], "read() (in module osirispy)": [[1, "osirispy.read"]], "track (class in osirispy)": [[1, "osirispy.track"]]}})