@@ -175,6 +192,8 @@ I
M
+ - MODEL_LIST (in module pyegt.defs)
+
- model_search() (in module pyegt.utils)
-
diff --git a/docs/height.html b/docs/height.html
index 9788ad6..752e79b 100644
--- a/docs/height.html
+++ b/docs/height.html
@@ -57,6 +57,10 @@
pyegt.height
pyegt.test
diff --git a/docs/objects.inv b/docs/objects.inv
index fd5dc87..04bf438 100644
Binary files a/docs/objects.inv and b/docs/objects.inv differ
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 1d9c8e2..2ce7c6f 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["about", "defs", "height", "index", "install", "lookups", "test", "utils"], "filenames": ["about.rst", "defs.rst", "height.rst", "index.rst", "install.rst", "lookups.rst", "test.rst", "utils.rst"], "titles": ["1. About pyegt", "pyegt.defs", "pyegt.height", "pyegt 0.1.2", "2. Installation", "3. Using pyegt", "pyegt.test", "pyegt.utils"], "terms": {"ncea": [0, 3], "cesium": [0, 2, 3], "i": [0, 2, 3, 4, 5, 7], "an": [0, 2, 3, 6, 7], "open": [0, 3], "sourc": [0, 3], "program": [0, 3], "develop": [0, 3], "look": [0, 2, 3], "up": [0, 2, 3, 4], "geoid": [0, 1, 2, 3, 5, 7], "tidal": [0, 1, 2, 3, 5, 7], "geopotenti": [0, 2, 3, 7], "model": [0, 1, 2, 3, 5, 7], "height": [0, 3, 5, 6, 7], "abov": [0, 2, 3], "ellipsoid": [0, 2, 3, 5], "order": [0, 2, 3], "convert": [0, 2, 3], "referenc": [0, 2, 3], "e": [0, 2, 3], "compat": [0, 2, 3], "vice": [0, 2, 3], "versa": [0, 2, 3], "The": [0, 2, 4, 5, 7], "follow": [0, 2, 4, 5, 6], "figur": [0, 2], "demonstr": [0, 2], "differ": [0, 2], "between": [0, 2], "topograph": [0, 2], "ground": [0, 2], "surfac": [0, 2], "diagram": [0, 2], "show": [0, 2], "conceptu": [0, 2], "h": [0, 2, 5], "rel": [0, 2, 3], "n": [0, 2, 4], "along": [0, 2], "grei": [0, 2], "gener": [0, 2, 7], "us": [0, 1, 2, 3, 4, 7], "global": [0, 2], "project": [0, 2], "due": [0, 2], "its": [0, 2], "small": [0, 2], "digit": [0, 2], "footprint": [0, 2], "eas": [0, 2], "calcul": [0, 2], "system": [0, 2], "base": [0, 2], "graviti": [0, 2], "howev": [0, 2], "tide": [0, 2], "ar": [0, 2, 4, 5], "influenc": [0, 2], "local": [0, 2], "earth": [0, 2], "": [0, 2], "densiti": [0, 2], "other": [0, 2], "factor": [0, 2], "therefor": [0, 2], "some": [0, 2], "prefer": [0, 2], "refer": [0, 1, 2], "which": [0, 2], "provid": [0, 2], "much": [0, 2], "easier": [0, 2], "framework": [0, 2], "understand": [0, 2], "exampl": [0, 2, 5, 7], "mean": [0, 2], "sea": [0, 2], "level": [0, 2], "potenti": [0, 2], "from": [0, 1, 2, 3, 5, 6, 7], "requir": [0, 2], "know": [0, 2], "convers": [0, 2], "simpl": [0, 2], "addit": [0, 2], "valu": [0, 2, 6], "lookup": [0, 2, 5, 7], "perform": [0, 2, 5], "heightmodel": [0, 2, 3, 5, 6], "class": [0, 2], "either": [0, 2, 4], "ng": [0, 1, 2, 5, 7], "vdatum": [0, 1, 2, 5, 7], "api": [0, 1, 2, 5, 7], "wrapper": [0, 5], "around": 0, "all": [0, 5], "function": [0, 5], "those": 0, "ha": [0, 2, 7], "been": [0, 2], "includ": 0, "thi": [0, 2], "softwar": [0, 5], "pleas": 0, "read": 0, "document": [0, 2], "consid": 0, "contribut": 0, "codebas": 0, "you": [0, 4], "feel": 0, "strongli": 0, "miss": 0, "featur": 0, "ngs_model": [1, 3, 7], "g99sss": [1, 2], "2": 1, "geoid03": [1, 2], "3": [1, 4, 7], "geoid06": [1, 2], "5": [1, 6], "geoid09": [1, 2], "7": [1, 6], "geoid12a": [1, 2], "12": 1, "geoid12b": [1, 2, 5, 6], "13": 1, "geoid18": [1, 2], "14": 1, "geoid99": [1, 2], "1": [1, 2, 4], "usgg2003": [1, 2], "4": 1, "usgg2009": [1, 2], "6": 1, "usgg2012": [1, 2], "11": 1, "xushg": [1, 2], "9": 1, "noaa": [1, 5], "number": 1, "map": 1, "region": [1, 2, 3, 5, 6, 7], "contigu": [1, 2, 5, 6], "ak": [1, 2, 6], "seak": [1, 2], "chesapeak_delawar": [1, 2], "westcoast": [1, 2], "gcnmi": [1, 2], "hi": [1, 2], "prvi": [1, 2, 6], "sgi": [1, 2], "spi": [1, 2], "sli": [1, 2], "list": [1, 2, 7], "vdatum_model": [1, 3, 7], "navd88": [1, 2, 7], "ngvd29": [1, 2], "asvd02": [1, 2], "w0_usgg2012": [1, 2], "guvd04": [1, 2], "nmvd03": [1, 2], "prvd02": [1, 2], "vivd09": [1, 2], "crd": [1, 2], "egm2008": [1, 2, 5, 6, 7], "egm1996": [1, 2], "egm1984": [1, 2], "xgeoid16b": [1, 2], "xgeoid17b": [1, 2], "xgeoid18b": [1, 2], "xgeoid19b": [1, 2], "xgeoid20b": [1, 2], "igld85": [1, 2], "lwd_igld85": [1, 2], "ohwm_igld85": [1, 2], "lmsl": [1, 2], "mllw": [1, 2], "mlw": [1, 2], "mtl": [1, 2], "dtl": [1, 2], "mhw": [1, 2], "mhhw": [1, 2], "lwd": [1, 2], "nad27": [1, 2], "nad83_1986": [1, 2], "nad83_2011": [1, 2], "nad83_nsrs2007": [1, 2], "nad83_marp00": [1, 2], "nad83_pacp00": [1, 2], "wgs84_g1674": [1, 2], "itrf2014": [1, 2], "igs14": [1, 2], "itrf2008": [1, 2], "igs08": [1, 2], "itrf2005": [1, 2], "igs2005": [1, 2], "wgs84_g1150": [1, 2], "itrf2000": [1, 2], "igs00": [1, 2], "igb00": [1, 2], "itrf96": [1, 2], "wgs84_g873": [1, 2], "itrf94": [1, 2], "itrf93": [1, 2], "itrf92": [1, 2], "siomit92": [1, 2], "wgs84_g730": [1, 2], "itrf91": [1, 2], "itrf90": [1, 2], "itrf89": [1, 2], "itrf88": [1, 2], "wgs84_transit": [1, 2], "wgs84_g1762": [1, 2], "wgs84_g2139": [1, 2], "vertic": [1, 2], "frame": 1, "index": [1, 2, 3, 6, 7], "search": [1, 2, 3, 6, 7], "page": [1, 2, 3, 6, 7], "back": [1, 2, 6, 7], "top": [1, 2, 6, 7], "lat": [2, 5, 6, 7], "float": [2, 5, 7], "lon": [2, 5, 6, 7], "str": [2, 7], "liter": [2, 7], "none": [2, 5, 7], "from_model": [2, 5, 6], "from_vr": 2, "cr": 2, "from_wkt": 2, "from_epsg": 2, "int": [2, 7], "paramet": [2, 6, 7], "decim": [2, 7], "latitud": [2, 7], "longitud": [2, 7], "see": [2, 3, 7], "available_region": 2, "pyproj": [2, 4], "is_vert": 2, "must": [2, 5], "true": 2, "main": 2, "sub": 2, "well": 2, "known": 2, "text": 2, "get": [2, 7], "vr": [2, 7], "epsg": 2, "code": [2, 4, 7], "as_dict": 2, "dict": [2, 7], "return": [2, 6, 7], "json": [2, 7], "object": [2, 5], "__dict__": 2, "type": [2, 7], "as_float": 2, "__float__": 2, "exist": 2, "as_str": 2, "string": 2, "__str__": 2, "available_model": 2, "avail": 2, "usabl": 2, "doc": 2, "comput": 2, "given": [2, 7], "Will": 2, "set": [2, 4, 7], "self": 2, "variabl": 2, "suppli": [2, 5], "final": 2, "call": 2, "get_height": 2, "valid": [2, 7], "can": [2, 4, 5], "found": [2, 7], "here": 2, "wkt": 2, "in_cm": 2, "centimet": 2, "cm": 2, "in_feet": 2, "imperi": 2, "foot": 2, "u": [2, 6, 7], "survei": [2, 7], "feet": [2, 7], "in_feet_us_survei": [2, 5], "0": [2, 4], "999998": 2, "ft": 2, "usft": 2, "verify_model": 2, "bool": 2, "term": [2, 7], "phrase": 2, "contain": [2, 7], "name": [2, 7], "ex": 2, "correctli": 2, "format": 2, "queri": [2, 5, 7], "http": [3, 4], "github": [3, 4], "com": [3, 4], "iannesbitt": [3, 4], "ian": 3, "nesbitt": 3, "ucsb": 3, "For": 3, "more": [2, 3], "inform": 3, "about": 3, "section": 3, "instal": 3, "pip": 3, "conda": 3, "def": [3, 7], "test": 3, "util": [3, 5], "get_ngs_json": [3, 7], "get_ngs_url": [3, 7], "get_vdatum_json": [3, 7], "get_vdatum_url": [3, 7], "request": 4, "pyegt": 4, "onli": 4, "depend": 4, "To": 4, "creat": 4, "your": 4, "virtual": 4, "environ": 4, "run": [4, 6], "anaconda": 4, "miniconda": 4, "packag": 4, "itself": 4, "specif": [4, 5], "channel": 4, "c": 4, "new": 4, "latest": 4, "commit": 4, "manual": 4, "execut": 4, "git": 4, "clone": 4, "cd": 4, "Or": 4, "directli": 4, "design": 5, "easi": 5, "simpli": 5, "initi": 5, "datum": 5, "against": 5, "import": [5, 6], "44": [5, 6], "256616": [5, 6], "73": [5, 6], "964784": [5, 6], "28": [5, 6], "157": [5, 6], "meter": [2, 5], "92": 5, "37842416572809": 5, "also": 5, "899": [5, 6], "argument": 5, "If": [5, 6], "user": 5, "default": 5, "highli": 5, "doe": 5, "Its": 5, "sole": 5, "locat": [2, 5], "try": [], "pr": 6, "coordin": 6, "ngs_url": 7, "applic": 7, "url": 7, "vdatum_url": 7, "definit": 1, "model_search": [3, 7], "rais": [2, 7], "attributeerror": [2, 7], "geoidheight": 7, "connectionerror": 7, "tri": 7, "respons": 7, "error": [6, 7], "egm": 7, "bad_nam": 7, "navd": 7, "88": 7, "A": 7, "verifi": 7, "indic": [2, 7], "describ": 2, "64": 6, "486036": 6, "165": 6, "292154": 6, "18": 6, "47131": 6, "66": 6, "136544": 6, "expect": 6, "expected_valu": 6, "43": 6, "285": 6, "005": 6, "45": 6, "473": 6, "construct": 7, "servic": 7, "model_list": 7, "valueerror": 2, "match": 2, "100": 2, "than": 2, "one": 2, "invalid": 7, "ani": 6, "fail": 6, "script": 6, "exit": 6, "after": 6, "print": 6, "result": 6}, "objects": {"pyegt": [[1, 0, 0, "-", "defs"], [2, 0, 0, "-", "height"], [6, 0, 0, "-", "test"], [7, 0, 0, "-", "utils"]], "pyegt.defs": [[1, 1, 1, "", "NGS_MODELS"], [1, 1, 1, "", "REGIONS"], [1, 1, 1, "", "VDATUM_MODELS"]], "pyegt.height": [[2, 2, 1, "", "HeightModel"]], "pyegt.height.HeightModel": [[2, 3, 1, "", "as_dict"], [2, 3, 1, "", "as_float"], [2, 3, 1, "", "as_string"], [2, 3, 1, "", "available_models"], [2, 3, 1, "", "available_regions"], [2, 3, 1, "", "from_epsg"], [2, 3, 1, "", "from_model"], [2, 3, 1, "", "from_vrs"], [2, 3, 1, "", "from_wkt"], [2, 3, 1, "", "get_height"], [2, 3, 1, "", "in_cm"], [2, 3, 1, "", "in_feet"], [2, 3, 1, "", "in_feet_us_survey"], [2, 3, 1, "", "verify_model"]], "pyegt.test": [[6, 4, 1, "", "test"]], "pyegt.utils": [[7, 4, 1, "", "get_ngs_json"], [7, 4, 1, "", "get_ngs_url"], [7, 4, 1, "", "get_vdatum_json"], [7, 4, 1, "", "get_vdatum_url"], [7, 4, 1, "", "model_search"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:method", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"]}, "titleterms": {"about": 0, "pyegt": [0, 1, 2, 3, 5, 6, 7], "def": 1, "height": 2, "0": 3, "1": 3, "resourc": 3, "librari": 3, "lookup": 3, "instal": 4, "pip": 4, "conda": 4, "from": 4, "sourc": 4, "us": 5, "test": 6, "util": 7, "2": 3}, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"About pyegt": [[0, "about-pyegt"]], "pyegt 0.1.2": [[3, "pyegt-version"]], "Resources": [[3, null]], "Library": [[3, null]], "Lookups": [[3, "lookups"]], "Installation": [[4, "installation"]], "pip": [[4, "pip"]], "conda": [[4, "conda"]], "From source": [[4, "from-source"]], "Using pyegt": [[5, "using-pyegt"]], "pyegt.defs": [[1, "module-pyegt.defs"]], "pyegt.height": [[2, "module-pyegt.height"]], "pyegt.utils": [[7, "module-pyegt.utils"]], "pyegt.test": [[6, "module-pyegt.test"]]}, "indexentries": {"module": [[6, "module-pyegt.test"]], "pyegt.test": [[6, "module-pyegt.test"]], "test() (in module pyegt.test)": [[6, "pyegt.test.test"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["about", "defs", "height", "index", "install", "lookups", "test", "utils"], "filenames": ["about.rst", "defs.rst", "height.rst", "index.rst", "install.rst", "lookups.rst", "test.rst", "utils.rst"], "titles": ["1. About pyegt", "pyegt.defs", "pyegt.height", "pyegt 0.1.2", "2. Installation", "3. Using pyegt", "pyegt.test", "pyegt.utils"], "terms": {"ncea": [0, 3], "cesium": [0, 2, 3], "i": [0, 2, 3, 4, 5, 7], "an": [0, 2, 3, 6, 7], "open": [0, 3], "sourc": [0, 3], "program": [0, 3], "develop": [0, 3], "look": [0, 2, 3], "up": [0, 2, 3, 4], "geoid": [0, 1, 2, 3, 5, 7], "tidal": [0, 1, 2, 3, 5, 7], "geopotenti": [0, 2, 3, 7], "model": [0, 1, 2, 3, 5, 7], "height": [0, 3, 5, 6, 7], "abov": [0, 2, 3], "ellipsoid": [0, 2, 3, 5], "order": [0, 2, 3], "convert": [0, 2, 3], "referenc": [0, 2, 3], "e": [0, 2, 3], "compat": [0, 2, 3], "vice": [0, 2, 3], "versa": [0, 2, 3], "The": [0, 1, 2, 4, 5, 7], "follow": [0, 2, 4, 5, 6], "figur": [0, 2], "demonstr": [0, 2], "differ": [0, 2], "between": [0, 2], "topograph": [0, 2], "ground": [0, 2], "surfac": [0, 2], "diagram": [0, 2], "show": [0, 2], "conceptu": [0, 2], "h": [0, 2, 5], "rel": [0, 2, 3], "n": [0, 2, 4], "along": [0, 2], "grei": [0, 2], "gener": [0, 2, 7], "us": [0, 1, 2, 3, 4, 7], "global": [0, 2], "project": [0, 2], "due": [0, 2], "its": [0, 2], "small": [0, 2], "digit": [0, 2], "footprint": [0, 2], "eas": [0, 2], "calcul": [0, 2], "system": [0, 2], "base": [0, 2], "graviti": [0, 2], "howev": [0, 2], "tide": [0, 2], "ar": [0, 2, 4, 5], "influenc": [0, 2], "local": [0, 2], "earth": [0, 2], "": [0, 2], "densiti": [0, 2], "other": [0, 2], "factor": [0, 2], "therefor": [0, 2], "some": [0, 2], "prefer": [0, 2], "refer": [0, 1, 2], "which": [0, 2], "provid": [0, 2], "much": [0, 2], "easier": [0, 2], "framework": [0, 2], "understand": [0, 2], "exampl": [0, 2, 5, 7], "mean": [0, 2], "sea": [0, 2], "level": [0, 2], "potenti": [0, 2], "from": [0, 1, 2, 3, 5, 6, 7], "requir": [0, 2], "know": [0, 2], "convers": [0, 2], "simpl": [0, 2], "addit": [0, 2], "valu": [0, 2, 6], "lookup": [0, 2, 5, 7], "perform": [0, 2, 5], "heightmodel": [0, 2, 3, 5, 6], "class": [0, 2], "either": [0, 2, 4], "ng": [0, 1, 2, 5, 7], "vdatum": [0, 1, 2, 5, 7], "api": [0, 1, 2, 5, 7], "wrapper": [0, 5], "around": 0, "all": [0, 5], "function": [0, 5], "those": 0, "ha": [0, 2, 7], "been": [0, 2], "includ": 0, "thi": [0, 2], "softwar": [0, 5], "pleas": 0, "read": 0, "document": [0, 2], "consid": 0, "contribut": 0, "codebas": 0, "you": [0, 4], "feel": 0, "strongli": 0, "miss": 0, "featur": 0, "ngs_model": [1, 3, 7], "g99sss": [1, 2], "2": 1, "geoid03": [1, 2], "3": [1, 4, 7], "geoid06": [1, 2], "5": [1, 6], "geoid09": [1, 2], "7": [1, 6], "geoid12a": [1, 2], "12": 1, "geoid12b": [1, 2, 5, 6], "13": 1, "geoid18": [1, 2], "14": 1, "geoid99": [1, 2], "1": [1, 2, 4], "usgg2003": [1, 2], "4": 1, "usgg2009": [1, 2], "6": [1, 2], "usgg2012": [1, 2], "11": 1, "xushg": [1, 2], "9": 1, "noaa": [1, 5], "number": [1, 2], "map": 1, "region": [1, 2, 3, 5, 6, 7], "contigu": [1, 2, 5, 6], "ak": [1, 2, 6], "seak": [1, 2], "chesapeak_delawar": [1, 2], "westcoast": [1, 2], "gcnmi": [1, 2], "hi": [1, 2], "prvi": [1, 2, 6], "sgi": [1, 2], "spi": [1, 2], "sli": [1, 2], "list": [1, 2, 7], "vdatum_model": [1, 3, 7], "navd88": [1, 2, 7], "ngvd29": [1, 2], "asvd02": [1, 2], "w0_usgg2012": [1, 2], "guvd04": [1, 2], "nmvd03": [1, 2], "prvd02": [1, 2], "vivd09": [1, 2], "crd": [1, 2], "egm2008": [1, 2, 5, 6, 7], "egm1996": [1, 2], "egm1984": [1, 2], "xgeoid16b": [1, 2], "xgeoid17b": [1, 2], "xgeoid18b": [1, 2], "xgeoid19b": [1, 2], "xgeoid20b": [1, 2], "igld85": [1, 2], "lwd_igld85": [1, 2], "ohwm_igld85": [1, 2], "lmsl": [1, 2], "mllw": [1, 2], "mlw": [1, 2], "mtl": [1, 2], "dtl": [1, 2], "mhw": [1, 2], "mhhw": [1, 2], "lwd": [1, 2], "nad27": [1, 2], "nad83_1986": [1, 2], "nad83_2011": [1, 2], "nad83_nsrs2007": [1, 2], "nad83_marp00": [1, 2], "nad83_pacp00": [1, 2], "wgs84_g1674": [1, 2], "itrf2014": [1, 2], "igs14": [1, 2], "itrf2008": [1, 2], "igs08": [1, 2], "itrf2005": [1, 2], "igs2005": [1, 2], "wgs84_g1150": [1, 2], "itrf2000": [1, 2], "igs00": [1, 2], "igb00": [1, 2], "itrf96": [1, 2], "wgs84_g873": [1, 2], "itrf94": [1, 2], "itrf93": [1, 2], "itrf92": [1, 2], "siomit92": [1, 2], "wgs84_g730": [1, 2], "itrf91": [1, 2], "itrf90": [1, 2], "itrf89": [1, 2], "itrf88": [1, 2], "wgs84_transit": [1, 2], "wgs84_g1762": [1, 2], "wgs84_g2139": [1, 2], "vertic": [1, 2], "frame": 1, "index": [1, 2, 3, 6, 7], "search": [1, 2, 3, 6, 7], "page": [1, 2, 3, 6, 7], "back": [1, 2, 6, 7], "top": [1, 2, 6, 7], "lat": [2, 5, 6, 7], "float": [2, 5, 7], "lon": [2, 5, 6, 7], "str": [2, 7], "liter": [2, 7], "none": [2, 5, 7], "from_model": [2, 5, 6], "from_vr": 2, "cr": 2, "from_wkt": 2, "from_epsg": 2, "int": [2, 7], "paramet": [2, 6, 7], "decim": [2, 7], "latitud": [2, 7], "longitud": [2, 7], "see": [2, 3, 7], "available_region": 2, "pyproj": [2, 4], "is_vert": 2, "must": [2, 5], "true": 2, "main": 2, "sub": 2, "well": 2, "known": 2, "text": 2, "get": [2, 7], "vr": [2, 7], "epsg": 2, "code": [2, 4, 7], "as_dict": 2, "dict": [2, 7], "return": [2, 6, 7], "json": [2, 7], "object": [2, 5], "__dict__": 2, "type": [2, 7], "as_float": 2, "__float__": 2, "exist": 2, "as_str": 2, "string": 2, "__str__": 2, "available_model": 2, "avail": 2, "usabl": 2, "doc": 2, "comput": 2, "given": [2, 7], "Will": 2, "set": [2, 4, 7], "self": 2, "variabl": 2, "suppli": [2, 5], "final": 2, "call": 2, "get_height": 2, "valid": [2, 7], "can": [2, 4, 5], "found": [2, 7], "here": [1, 2], "wkt": 2, "in_cm": 2, "centimet": 2, "cm": 2, "in_feet": 2, "imperi": 2, "foot": 2, "u": [2, 6, 7], "survei": [2, 7], "feet": [2, 7], "in_feet_us_survei": [2, 5], "0": [2, 4], "999998": 2, "ft": 2, "usft": 2, "verify_model": 2, "bool": 2, "term": [2, 7], "phrase": 2, "contain": [2, 7], "name": [2, 7], "ex": 2, "correctli": 2, "format": 2, "queri": [2, 5, 7], "http": [3, 4], "github": [3, 4], "com": [3, 4], "iannesbitt": [3, 4], "ian": 3, "nesbitt": 3, "ucsb": 3, "For": 3, "more": [2, 3], "inform": 3, "about": 3, "section": 3, "instal": 3, "pip": 3, "conda": 3, "def": [3, 7], "test": 3, "util": [3, 5], "get_ngs_json": [3, 7], "get_ngs_url": [3, 7], "get_vdatum_json": [3, 7], "get_vdatum_url": [3, 7], "request": 4, "pyegt": 4, "onli": 4, "depend": 4, "To": 4, "creat": 4, "your": 4, "virtual": 4, "environ": 4, "run": [4, 6], "anaconda": 4, "miniconda": 4, "packag": 4, "itself": 4, "specif": [4, 5], "channel": 4, "c": 4, "new": 4, "latest": 4, "commit": 4, "manual": 4, "execut": 4, "git": 4, "clone": 4, "cd": 4, "Or": 4, "directli": [2, 4], "design": 5, "easi": 5, "simpli": 5, "initi": 5, "datum": 5, "against": 5, "import": [2, 5, 6], "44": [5, 6], "256616": [5, 6], "73": [5, 6], "964784": [5, 6], "28": [5, 6], "157": [5, 6], "meter": [2, 5], "92": 5, "37842416572809": 5, "also": 5, "899": [5, 6], "argument": 5, "If": [5, 6], "user": 5, "default": 5, "highli": 5, "doe": 5, "Its": 5, "sole": 5, "locat": [2, 5], "try": [], "pr": 6, "coordin": 6, "ngs_url": 7, "applic": 7, "url": 7, "vdatum_url": 7, "definit": 1, "model_search": [3, 7], "rais": [2, 7], "attributeerror": [2, 7], "geoidheight": 7, "connectionerror": 7, "tri": 7, "respons": 7, "error": [6, 7], "egm": 7, "bad_nam": 7, "navd": 7, "88": 7, "A": 7, "verifi": 7, "indic": [2, 7], "describ": [1, 2], "64": [2, 6], "486036": 6, "165": [2, 6], "292154": 6, "18": 6, "47131": 6, "66": 6, "136544": 6, "expect": 6, "expected_valu": 6, "43": 6, "285": 6, "005": 6, "45": 6, "473": 6, "construct": 7, "servic": 7, "model_list": [1, 3, 7], "valueerror": 2, "match": 2, "100": 2, "than": 2, "one": 2, "invalid": 7, "ani": 6, "fail": 6, "script": 6, "exit": 6, "after": 6, "print": 6, "result": 6, "full": 1, "amalgam": [], "both": [], "concaten": 1, "repres": 2, "__eq__": 2, "_heightmodel__valu": 2, "math": 2, "isclos": 2, "compar": 2, "point": 2, "alwai": 2, "boolean": 2, "equal": 2, "two": 2, "__repr__": 2, "printabl": 2, "represent": 2, "506181": 2, "399282": 2, "repr": 2, "998": 2}, "objects": {"pyegt": [[1, 0, 0, "-", "defs"], [2, 0, 0, "-", "height"], [6, 0, 0, "-", "test"], [7, 0, 0, "-", "utils"]], "pyegt.defs": [[1, 1, 1, "", "MODEL_LIST"], [1, 1, 1, "", "NGS_MODELS"], [1, 1, 1, "", "REGIONS"], [1, 1, 1, "", "VDATUM_MODELS"]], "pyegt.height": [[2, 2, 1, "", "HeightModel"]], "pyegt.height.HeightModel": [[2, 3, 1, "", "__eq__"], [2, 3, 1, "", "__float__"], [2, 3, 1, "", "__repr__"], [2, 3, 1, "", "__str__"], [2, 3, 1, "", "as_dict"], [2, 3, 1, "", "as_float"], [2, 3, 1, "", "as_string"], [2, 3, 1, "", "available_models"], [2, 3, 1, "", "available_regions"], [2, 3, 1, "", "from_epsg"], [2, 3, 1, "", "from_model"], [2, 3, 1, "", "from_vrs"], [2, 3, 1, "", "from_wkt"], [2, 3, 1, "", "get_height"], [2, 3, 1, "", "in_cm"], [2, 3, 1, "", "in_feet"], [2, 3, 1, "", "in_feet_us_survey"], [2, 3, 1, "", "verify_model"]], "pyegt.test": [[6, 4, 1, "", "test"]], "pyegt.utils": [[7, 4, 1, "", "get_ngs_json"], [7, 4, 1, "", "get_ngs_url"], [7, 4, 1, "", "get_vdatum_json"], [7, 4, 1, "", "get_vdatum_url"], [7, 4, 1, "", "model_search"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:method", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"]}, "titleterms": {"about": 0, "pyegt": [0, 1, 2, 3, 5, 6, 7], "def": 1, "height": 2, "0": 3, "1": 3, "resourc": 3, "librari": 3, "lookup": 3, "instal": 4, "pip": 4, "conda": 4, "from": 4, "sourc": 4, "us": 5, "test": 6, "util": 7, "2": 3}, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"About pyegt": [[0, "about-pyegt"]], "pyegt 0.1.2": [[3, "pyegt-version"]], "Resources": [[3, null]], "Library": [[3, null]], "Lookups": [[3, "lookups"]], "Installation": [[4, "installation"]], "pip": [[4, "pip"]], "conda": [[4, "conda"]], "From source": [[4, "from-source"]], "Using pyegt": [[5, "using-pyegt"]], "pyegt.utils": [[7, "module-pyegt.utils"]], "pyegt.defs": [[1, "module-pyegt.defs"]], "pyegt.test": [[6, "module-pyegt.test"]], "pyegt.height": [[2, "module-pyegt.height"]]}, "indexentries": {"heightmodel (class in pyegt.height)": [[2, "pyegt.height.HeightModel"]], "__eq__() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.__eq__"]], "__float__() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.__float__"]], "__repr__() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.__repr__"]], "__str__() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.__str__"]], "as_dict() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.as_dict"]], "as_float() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.as_float"]], "as_string() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.as_string"]], "available_models() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.available_models"]], "available_regions() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.available_regions"]], "from_epsg() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.from_epsg"]], "from_model() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.from_model"]], "from_vrs() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.from_vrs"]], "from_wkt() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.from_wkt"]], "get_height() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.get_height"]], "in_cm() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.in_cm"]], "in_feet() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.in_feet"]], "in_feet_us_survey() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.in_feet_us_survey"]], "module": [[2, "module-pyegt.height"]], "pyegt.height": [[2, "module-pyegt.height"]], "verify_model() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.verify_model"]]}})
\ No newline at end of file
diff --git a/docs/utils.html b/docs/utils.html
index 99cc2a6..2ffc0f3 100644
--- a/docs/utils.html
+++ b/docs/utils.html
@@ -110,7 +110,7 @@
- Raises:
-
@@ -158,6 +158,7 @@
-
diff --git a/docsrc/_build/doctrees/defs.doctree b/docsrc/_build/doctrees/defs.doctree
index af6409a..9c30f0b 100644
Binary files a/docsrc/_build/doctrees/defs.doctree and b/docsrc/_build/doctrees/defs.doctree differ
diff --git a/docsrc/_build/doctrees/environment.pickle b/docsrc/_build/doctrees/environment.pickle
index 55f14eb..6ab9b8f 100644
Binary files a/docsrc/_build/doctrees/environment.pickle and b/docsrc/_build/doctrees/environment.pickle differ
diff --git a/docsrc/_build/doctrees/height.doctree b/docsrc/_build/doctrees/height.doctree
index 137ded5..0d69bcf 100644
Binary files a/docsrc/_build/doctrees/height.doctree and b/docsrc/_build/doctrees/height.doctree differ
diff --git a/docsrc/_build/doctrees/utils.doctree b/docsrc/_build/doctrees/utils.doctree
index 8cad1c4..96e765f 100644
Binary files a/docsrc/_build/doctrees/utils.doctree and b/docsrc/_build/doctrees/utils.doctree differ
diff --git a/docsrc/_build/html/_sources/defs.rst.txt b/docsrc/_build/html/_sources/defs.rst.txt
index 0ce9875..e0bc17d 100644
--- a/docsrc/_build/html/_sources/defs.rst.txt
+++ b/docsrc/_build/html/_sources/defs.rst.txt
@@ -4,6 +4,30 @@
.. automodule:: pyegt.defs
:members:
+.. py:data:: MODEL_LIST
+ :type: list
+
+ The full list of models from NGS and VDatum APIs described here,
+ concatenated from :py:data:`pyegt.defs.NGS_MODELS` and
+ :py:data:`pyegt.defs.VDATUM_MODELS`::
+
+ MODEL_LIST = [
+ 'GEOID99', 'G99SSS', 'GEOID03', 'USGG2003', 'GEOID06', 'USGG2009',
+ 'GEOID09', 'XUSHG', 'USGG2012', 'GEOID12A', 'GEOID12B', 'GEOID18',
+ 'NAVD88', 'NGVD29', 'ASVD02', 'W0_USGG2012', 'GUVD04', 'NMVD03',
+ 'PRVD02', 'VIVD09', 'CRD', 'EGM2008', 'EGM1996', 'EGM1984',
+ 'XGEOID16B', 'XGEOID17B', 'XGEOID18B', 'XGEOID19B', 'XGEOID20B',
+ 'IGLD85', 'LWD_IGLD85', 'OHWM_IGLD85', 'CRD', 'LMSL', 'MLLW',
+ 'MLW', 'MTL', 'DTL', 'MHW', 'MHHW', 'LWD', 'NAD27', 'NAD83_1986',
+ 'NAD83_2011', 'NAD83_NSRS2007', 'NAD83_MARP00', 'NAD83_PACP00',
+ 'WGS84_G1674', 'ITRF2014', 'IGS14', 'ITRF2008', 'IGS08',
+ 'ITRF2005', 'IGS2005', 'WGS84_G1150', 'ITRF2000', 'IGS00', 'IGb00',
+ 'ITRF96', 'WGS84_G873', 'ITRF94', 'ITRF93', 'ITRF92', 'SIOMIT92',
+ 'WGS84_G730', 'ITRF91', 'ITRF90', 'ITRF89', 'ITRF88',
+ 'WGS84_TRANSIT', 'WGS84_G1762', 'WGS84_G2139'
+ ]
+
+
................
* :ref:`genindex`
diff --git a/docsrc/_build/html/_sources/height.rst.txt b/docsrc/_build/html/_sources/height.rst.txt
index 2e5bef5..d507802 100644
--- a/docsrc/_build/html/_sources/height.rst.txt
+++ b/docsrc/_build/html/_sources/height.rst.txt
@@ -3,6 +3,7 @@
.. automodule:: pyegt.height
:members:
+ :special-members: __dict__, __eq__, __float__, __repr__, __str__
................
diff --git a/docsrc/_build/html/defs.html b/docsrc/_build/html/defs.html
index d460a48..71c8ac6 100644
--- a/docsrc/_build/html/defs.html
+++ b/docsrc/_build/html/defs.html
@@ -60,6 +60,7 @@
NGS_MODELSREGIONSVDATUM_MODELSMODEL_LIST
pyegt.test
+-
+pyegt.defs.MODEL_LIST: list
+The full list of models from NGS and VDatum APIs described here,
+concatenated from pyegt.defs.NGS_MODELS and
+pyegt.defs.VDATUM_MODELS:
+MODEL_LIST = [
+ 'GEOID99', 'G99SSS', 'GEOID03', 'USGG2003', 'GEOID06', 'USGG2009',
+ 'GEOID09', 'XUSHG', 'USGG2012', 'GEOID12A', 'GEOID12B', 'GEOID18',
+ 'NAVD88', 'NGVD29', 'ASVD02', 'W0_USGG2012', 'GUVD04', 'NMVD03',
+ 'PRVD02', 'VIVD09', 'CRD', 'EGM2008', 'EGM1996', 'EGM1984',
+ 'XGEOID16B', 'XGEOID17B', 'XGEOID18B', 'XGEOID19B', 'XGEOID20B',
+ 'IGLD85', 'LWD_IGLD85', 'OHWM_IGLD85', 'CRD', 'LMSL', 'MLLW',
+ 'MLW', 'MTL', 'DTL', 'MHW', 'MHHW', 'LWD', 'NAD27', 'NAD83_1986',
+ 'NAD83_2011', 'NAD83_NSRS2007', 'NAD83_MARP00', 'NAD83_PACP00',
+ 'WGS84_G1674', 'ITRF2014', 'IGS14', 'ITRF2008', 'IGS08',
+ 'ITRF2005', 'IGS2005', 'WGS84_G1150', 'ITRF2000', 'IGS00', 'IGb00',
+ 'ITRF96', 'WGS84_G873', 'ITRF94', 'ITRF93', 'ITRF92', 'SIOMIT92',
+ 'WGS84_G730', 'ITRF91', 'ITRF90', 'ITRF89', 'ITRF88',
+ 'WGS84_TRANSIT', 'WGS84_G1762', 'WGS84_G2139'
+]
+
+
+
Index Index
- A
+ _
+ | A
| F
| G
| H
@@ -98,6 +99,22 @@ Index
| V
_
+
+
A
@@ -175,6 +192,8 @@ I
M
+ - MODEL_LIST (in module pyegt.defs)
+
- model_search() (in module pyegt.utils)
-
diff --git a/docsrc/_build/html/height.html b/docsrc/_build/html/height.html
index 9788ad6..752e79b 100644
--- a/docsrc/_build/html/height.html
+++ b/docsrc/_build/html/height.html
@@ -57,6 +57,10 @@
pyegt.height
pyegt.test
diff --git a/docsrc/_build/html/objects.inv b/docsrc/_build/html/objects.inv
index fd5dc87..04bf438 100644
Binary files a/docsrc/_build/html/objects.inv and b/docsrc/_build/html/objects.inv differ
diff --git a/docsrc/_build/html/searchindex.js b/docsrc/_build/html/searchindex.js
index 1d9c8e2..2ce7c6f 100644
--- a/docsrc/_build/html/searchindex.js
+++ b/docsrc/_build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["about", "defs", "height", "index", "install", "lookups", "test", "utils"], "filenames": ["about.rst", "defs.rst", "height.rst", "index.rst", "install.rst", "lookups.rst", "test.rst", "utils.rst"], "titles": ["1. About pyegt", "pyegt.defs", "pyegt.height", "pyegt 0.1.2", "2. Installation", "3. Using pyegt", "pyegt.test", "pyegt.utils"], "terms": {"ncea": [0, 3], "cesium": [0, 2, 3], "i": [0, 2, 3, 4, 5, 7], "an": [0, 2, 3, 6, 7], "open": [0, 3], "sourc": [0, 3], "program": [0, 3], "develop": [0, 3], "look": [0, 2, 3], "up": [0, 2, 3, 4], "geoid": [0, 1, 2, 3, 5, 7], "tidal": [0, 1, 2, 3, 5, 7], "geopotenti": [0, 2, 3, 7], "model": [0, 1, 2, 3, 5, 7], "height": [0, 3, 5, 6, 7], "abov": [0, 2, 3], "ellipsoid": [0, 2, 3, 5], "order": [0, 2, 3], "convert": [0, 2, 3], "referenc": [0, 2, 3], "e": [0, 2, 3], "compat": [0, 2, 3], "vice": [0, 2, 3], "versa": [0, 2, 3], "The": [0, 2, 4, 5, 7], "follow": [0, 2, 4, 5, 6], "figur": [0, 2], "demonstr": [0, 2], "differ": [0, 2], "between": [0, 2], "topograph": [0, 2], "ground": [0, 2], "surfac": [0, 2], "diagram": [0, 2], "show": [0, 2], "conceptu": [0, 2], "h": [0, 2, 5], "rel": [0, 2, 3], "n": [0, 2, 4], "along": [0, 2], "grei": [0, 2], "gener": [0, 2, 7], "us": [0, 1, 2, 3, 4, 7], "global": [0, 2], "project": [0, 2], "due": [0, 2], "its": [0, 2], "small": [0, 2], "digit": [0, 2], "footprint": [0, 2], "eas": [0, 2], "calcul": [0, 2], "system": [0, 2], "base": [0, 2], "graviti": [0, 2], "howev": [0, 2], "tide": [0, 2], "ar": [0, 2, 4, 5], "influenc": [0, 2], "local": [0, 2], "earth": [0, 2], "": [0, 2], "densiti": [0, 2], "other": [0, 2], "factor": [0, 2], "therefor": [0, 2], "some": [0, 2], "prefer": [0, 2], "refer": [0, 1, 2], "which": [0, 2], "provid": [0, 2], "much": [0, 2], "easier": [0, 2], "framework": [0, 2], "understand": [0, 2], "exampl": [0, 2, 5, 7], "mean": [0, 2], "sea": [0, 2], "level": [0, 2], "potenti": [0, 2], "from": [0, 1, 2, 3, 5, 6, 7], "requir": [0, 2], "know": [0, 2], "convers": [0, 2], "simpl": [0, 2], "addit": [0, 2], "valu": [0, 2, 6], "lookup": [0, 2, 5, 7], "perform": [0, 2, 5], "heightmodel": [0, 2, 3, 5, 6], "class": [0, 2], "either": [0, 2, 4], "ng": [0, 1, 2, 5, 7], "vdatum": [0, 1, 2, 5, 7], "api": [0, 1, 2, 5, 7], "wrapper": [0, 5], "around": 0, "all": [0, 5], "function": [0, 5], "those": 0, "ha": [0, 2, 7], "been": [0, 2], "includ": 0, "thi": [0, 2], "softwar": [0, 5], "pleas": 0, "read": 0, "document": [0, 2], "consid": 0, "contribut": 0, "codebas": 0, "you": [0, 4], "feel": 0, "strongli": 0, "miss": 0, "featur": 0, "ngs_model": [1, 3, 7], "g99sss": [1, 2], "2": 1, "geoid03": [1, 2], "3": [1, 4, 7], "geoid06": [1, 2], "5": [1, 6], "geoid09": [1, 2], "7": [1, 6], "geoid12a": [1, 2], "12": 1, "geoid12b": [1, 2, 5, 6], "13": 1, "geoid18": [1, 2], "14": 1, "geoid99": [1, 2], "1": [1, 2, 4], "usgg2003": [1, 2], "4": 1, "usgg2009": [1, 2], "6": 1, "usgg2012": [1, 2], "11": 1, "xushg": [1, 2], "9": 1, "noaa": [1, 5], "number": 1, "map": 1, "region": [1, 2, 3, 5, 6, 7], "contigu": [1, 2, 5, 6], "ak": [1, 2, 6], "seak": [1, 2], "chesapeak_delawar": [1, 2], "westcoast": [1, 2], "gcnmi": [1, 2], "hi": [1, 2], "prvi": [1, 2, 6], "sgi": [1, 2], "spi": [1, 2], "sli": [1, 2], "list": [1, 2, 7], "vdatum_model": [1, 3, 7], "navd88": [1, 2, 7], "ngvd29": [1, 2], "asvd02": [1, 2], "w0_usgg2012": [1, 2], "guvd04": [1, 2], "nmvd03": [1, 2], "prvd02": [1, 2], "vivd09": [1, 2], "crd": [1, 2], "egm2008": [1, 2, 5, 6, 7], "egm1996": [1, 2], "egm1984": [1, 2], "xgeoid16b": [1, 2], "xgeoid17b": [1, 2], "xgeoid18b": [1, 2], "xgeoid19b": [1, 2], "xgeoid20b": [1, 2], "igld85": [1, 2], "lwd_igld85": [1, 2], "ohwm_igld85": [1, 2], "lmsl": [1, 2], "mllw": [1, 2], "mlw": [1, 2], "mtl": [1, 2], "dtl": [1, 2], "mhw": [1, 2], "mhhw": [1, 2], "lwd": [1, 2], "nad27": [1, 2], "nad83_1986": [1, 2], "nad83_2011": [1, 2], "nad83_nsrs2007": [1, 2], "nad83_marp00": [1, 2], "nad83_pacp00": [1, 2], "wgs84_g1674": [1, 2], "itrf2014": [1, 2], "igs14": [1, 2], "itrf2008": [1, 2], "igs08": [1, 2], "itrf2005": [1, 2], "igs2005": [1, 2], "wgs84_g1150": [1, 2], "itrf2000": [1, 2], "igs00": [1, 2], "igb00": [1, 2], "itrf96": [1, 2], "wgs84_g873": [1, 2], "itrf94": [1, 2], "itrf93": [1, 2], "itrf92": [1, 2], "siomit92": [1, 2], "wgs84_g730": [1, 2], "itrf91": [1, 2], "itrf90": [1, 2], "itrf89": [1, 2], "itrf88": [1, 2], "wgs84_transit": [1, 2], "wgs84_g1762": [1, 2], "wgs84_g2139": [1, 2], "vertic": [1, 2], "frame": 1, "index": [1, 2, 3, 6, 7], "search": [1, 2, 3, 6, 7], "page": [1, 2, 3, 6, 7], "back": [1, 2, 6, 7], "top": [1, 2, 6, 7], "lat": [2, 5, 6, 7], "float": [2, 5, 7], "lon": [2, 5, 6, 7], "str": [2, 7], "liter": [2, 7], "none": [2, 5, 7], "from_model": [2, 5, 6], "from_vr": 2, "cr": 2, "from_wkt": 2, "from_epsg": 2, "int": [2, 7], "paramet": [2, 6, 7], "decim": [2, 7], "latitud": [2, 7], "longitud": [2, 7], "see": [2, 3, 7], "available_region": 2, "pyproj": [2, 4], "is_vert": 2, "must": [2, 5], "true": 2, "main": 2, "sub": 2, "well": 2, "known": 2, "text": 2, "get": [2, 7], "vr": [2, 7], "epsg": 2, "code": [2, 4, 7], "as_dict": 2, "dict": [2, 7], "return": [2, 6, 7], "json": [2, 7], "object": [2, 5], "__dict__": 2, "type": [2, 7], "as_float": 2, "__float__": 2, "exist": 2, "as_str": 2, "string": 2, "__str__": 2, "available_model": 2, "avail": 2, "usabl": 2, "doc": 2, "comput": 2, "given": [2, 7], "Will": 2, "set": [2, 4, 7], "self": 2, "variabl": 2, "suppli": [2, 5], "final": 2, "call": 2, "get_height": 2, "valid": [2, 7], "can": [2, 4, 5], "found": [2, 7], "here": 2, "wkt": 2, "in_cm": 2, "centimet": 2, "cm": 2, "in_feet": 2, "imperi": 2, "foot": 2, "u": [2, 6, 7], "survei": [2, 7], "feet": [2, 7], "in_feet_us_survei": [2, 5], "0": [2, 4], "999998": 2, "ft": 2, "usft": 2, "verify_model": 2, "bool": 2, "term": [2, 7], "phrase": 2, "contain": [2, 7], "name": [2, 7], "ex": 2, "correctli": 2, "format": 2, "queri": [2, 5, 7], "http": [3, 4], "github": [3, 4], "com": [3, 4], "iannesbitt": [3, 4], "ian": 3, "nesbitt": 3, "ucsb": 3, "For": 3, "more": [2, 3], "inform": 3, "about": 3, "section": 3, "instal": 3, "pip": 3, "conda": 3, "def": [3, 7], "test": 3, "util": [3, 5], "get_ngs_json": [3, 7], "get_ngs_url": [3, 7], "get_vdatum_json": [3, 7], "get_vdatum_url": [3, 7], "request": 4, "pyegt": 4, "onli": 4, "depend": 4, "To": 4, "creat": 4, "your": 4, "virtual": 4, "environ": 4, "run": [4, 6], "anaconda": 4, "miniconda": 4, "packag": 4, "itself": 4, "specif": [4, 5], "channel": 4, "c": 4, "new": 4, "latest": 4, "commit": 4, "manual": 4, "execut": 4, "git": 4, "clone": 4, "cd": 4, "Or": 4, "directli": 4, "design": 5, "easi": 5, "simpli": 5, "initi": 5, "datum": 5, "against": 5, "import": [5, 6], "44": [5, 6], "256616": [5, 6], "73": [5, 6], "964784": [5, 6], "28": [5, 6], "157": [5, 6], "meter": [2, 5], "92": 5, "37842416572809": 5, "also": 5, "899": [5, 6], "argument": 5, "If": [5, 6], "user": 5, "default": 5, "highli": 5, "doe": 5, "Its": 5, "sole": 5, "locat": [2, 5], "try": [], "pr": 6, "coordin": 6, "ngs_url": 7, "applic": 7, "url": 7, "vdatum_url": 7, "definit": 1, "model_search": [3, 7], "rais": [2, 7], "attributeerror": [2, 7], "geoidheight": 7, "connectionerror": 7, "tri": 7, "respons": 7, "error": [6, 7], "egm": 7, "bad_nam": 7, "navd": 7, "88": 7, "A": 7, "verifi": 7, "indic": [2, 7], "describ": 2, "64": 6, "486036": 6, "165": 6, "292154": 6, "18": 6, "47131": 6, "66": 6, "136544": 6, "expect": 6, "expected_valu": 6, "43": 6, "285": 6, "005": 6, "45": 6, "473": 6, "construct": 7, "servic": 7, "model_list": 7, "valueerror": 2, "match": 2, "100": 2, "than": 2, "one": 2, "invalid": 7, "ani": 6, "fail": 6, "script": 6, "exit": 6, "after": 6, "print": 6, "result": 6}, "objects": {"pyegt": [[1, 0, 0, "-", "defs"], [2, 0, 0, "-", "height"], [6, 0, 0, "-", "test"], [7, 0, 0, "-", "utils"]], "pyegt.defs": [[1, 1, 1, "", "NGS_MODELS"], [1, 1, 1, "", "REGIONS"], [1, 1, 1, "", "VDATUM_MODELS"]], "pyegt.height": [[2, 2, 1, "", "HeightModel"]], "pyegt.height.HeightModel": [[2, 3, 1, "", "as_dict"], [2, 3, 1, "", "as_float"], [2, 3, 1, "", "as_string"], [2, 3, 1, "", "available_models"], [2, 3, 1, "", "available_regions"], [2, 3, 1, "", "from_epsg"], [2, 3, 1, "", "from_model"], [2, 3, 1, "", "from_vrs"], [2, 3, 1, "", "from_wkt"], [2, 3, 1, "", "get_height"], [2, 3, 1, "", "in_cm"], [2, 3, 1, "", "in_feet"], [2, 3, 1, "", "in_feet_us_survey"], [2, 3, 1, "", "verify_model"]], "pyegt.test": [[6, 4, 1, "", "test"]], "pyegt.utils": [[7, 4, 1, "", "get_ngs_json"], [7, 4, 1, "", "get_ngs_url"], [7, 4, 1, "", "get_vdatum_json"], [7, 4, 1, "", "get_vdatum_url"], [7, 4, 1, "", "model_search"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:method", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"]}, "titleterms": {"about": 0, "pyegt": [0, 1, 2, 3, 5, 6, 7], "def": 1, "height": 2, "0": 3, "1": 3, "resourc": 3, "librari": 3, "lookup": 3, "instal": 4, "pip": 4, "conda": 4, "from": 4, "sourc": 4, "us": 5, "test": 6, "util": 7, "2": 3}, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"About pyegt": [[0, "about-pyegt"]], "pyegt 0.1.2": [[3, "pyegt-version"]], "Resources": [[3, null]], "Library": [[3, null]], "Lookups": [[3, "lookups"]], "Installation": [[4, "installation"]], "pip": [[4, "pip"]], "conda": [[4, "conda"]], "From source": [[4, "from-source"]], "Using pyegt": [[5, "using-pyegt"]], "pyegt.defs": [[1, "module-pyegt.defs"]], "pyegt.height": [[2, "module-pyegt.height"]], "pyegt.utils": [[7, "module-pyegt.utils"]], "pyegt.test": [[6, "module-pyegt.test"]]}, "indexentries": {"module": [[6, "module-pyegt.test"]], "pyegt.test": [[6, "module-pyegt.test"]], "test() (in module pyegt.test)": [[6, "pyegt.test.test"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["about", "defs", "height", "index", "install", "lookups", "test", "utils"], "filenames": ["about.rst", "defs.rst", "height.rst", "index.rst", "install.rst", "lookups.rst", "test.rst", "utils.rst"], "titles": ["1. About pyegt", "pyegt.defs", "pyegt.height", "pyegt 0.1.2", "2. Installation", "3. Using pyegt", "pyegt.test", "pyegt.utils"], "terms": {"ncea": [0, 3], "cesium": [0, 2, 3], "i": [0, 2, 3, 4, 5, 7], "an": [0, 2, 3, 6, 7], "open": [0, 3], "sourc": [0, 3], "program": [0, 3], "develop": [0, 3], "look": [0, 2, 3], "up": [0, 2, 3, 4], "geoid": [0, 1, 2, 3, 5, 7], "tidal": [0, 1, 2, 3, 5, 7], "geopotenti": [0, 2, 3, 7], "model": [0, 1, 2, 3, 5, 7], "height": [0, 3, 5, 6, 7], "abov": [0, 2, 3], "ellipsoid": [0, 2, 3, 5], "order": [0, 2, 3], "convert": [0, 2, 3], "referenc": [0, 2, 3], "e": [0, 2, 3], "compat": [0, 2, 3], "vice": [0, 2, 3], "versa": [0, 2, 3], "The": [0, 1, 2, 4, 5, 7], "follow": [0, 2, 4, 5, 6], "figur": [0, 2], "demonstr": [0, 2], "differ": [0, 2], "between": [0, 2], "topograph": [0, 2], "ground": [0, 2], "surfac": [0, 2], "diagram": [0, 2], "show": [0, 2], "conceptu": [0, 2], "h": [0, 2, 5], "rel": [0, 2, 3], "n": [0, 2, 4], "along": [0, 2], "grei": [0, 2], "gener": [0, 2, 7], "us": [0, 1, 2, 3, 4, 7], "global": [0, 2], "project": [0, 2], "due": [0, 2], "its": [0, 2], "small": [0, 2], "digit": [0, 2], "footprint": [0, 2], "eas": [0, 2], "calcul": [0, 2], "system": [0, 2], "base": [0, 2], "graviti": [0, 2], "howev": [0, 2], "tide": [0, 2], "ar": [0, 2, 4, 5], "influenc": [0, 2], "local": [0, 2], "earth": [0, 2], "": [0, 2], "densiti": [0, 2], "other": [0, 2], "factor": [0, 2], "therefor": [0, 2], "some": [0, 2], "prefer": [0, 2], "refer": [0, 1, 2], "which": [0, 2], "provid": [0, 2], "much": [0, 2], "easier": [0, 2], "framework": [0, 2], "understand": [0, 2], "exampl": [0, 2, 5, 7], "mean": [0, 2], "sea": [0, 2], "level": [0, 2], "potenti": [0, 2], "from": [0, 1, 2, 3, 5, 6, 7], "requir": [0, 2], "know": [0, 2], "convers": [0, 2], "simpl": [0, 2], "addit": [0, 2], "valu": [0, 2, 6], "lookup": [0, 2, 5, 7], "perform": [0, 2, 5], "heightmodel": [0, 2, 3, 5, 6], "class": [0, 2], "either": [0, 2, 4], "ng": [0, 1, 2, 5, 7], "vdatum": [0, 1, 2, 5, 7], "api": [0, 1, 2, 5, 7], "wrapper": [0, 5], "around": 0, "all": [0, 5], "function": [0, 5], "those": 0, "ha": [0, 2, 7], "been": [0, 2], "includ": 0, "thi": [0, 2], "softwar": [0, 5], "pleas": 0, "read": 0, "document": [0, 2], "consid": 0, "contribut": 0, "codebas": 0, "you": [0, 4], "feel": 0, "strongli": 0, "miss": 0, "featur": 0, "ngs_model": [1, 3, 7], "g99sss": [1, 2], "2": 1, "geoid03": [1, 2], "3": [1, 4, 7], "geoid06": [1, 2], "5": [1, 6], "geoid09": [1, 2], "7": [1, 6], "geoid12a": [1, 2], "12": 1, "geoid12b": [1, 2, 5, 6], "13": 1, "geoid18": [1, 2], "14": 1, "geoid99": [1, 2], "1": [1, 2, 4], "usgg2003": [1, 2], "4": 1, "usgg2009": [1, 2], "6": [1, 2], "usgg2012": [1, 2], "11": 1, "xushg": [1, 2], "9": 1, "noaa": [1, 5], "number": [1, 2], "map": 1, "region": [1, 2, 3, 5, 6, 7], "contigu": [1, 2, 5, 6], "ak": [1, 2, 6], "seak": [1, 2], "chesapeak_delawar": [1, 2], "westcoast": [1, 2], "gcnmi": [1, 2], "hi": [1, 2], "prvi": [1, 2, 6], "sgi": [1, 2], "spi": [1, 2], "sli": [1, 2], "list": [1, 2, 7], "vdatum_model": [1, 3, 7], "navd88": [1, 2, 7], "ngvd29": [1, 2], "asvd02": [1, 2], "w0_usgg2012": [1, 2], "guvd04": [1, 2], "nmvd03": [1, 2], "prvd02": [1, 2], "vivd09": [1, 2], "crd": [1, 2], "egm2008": [1, 2, 5, 6, 7], "egm1996": [1, 2], "egm1984": [1, 2], "xgeoid16b": [1, 2], "xgeoid17b": [1, 2], "xgeoid18b": [1, 2], "xgeoid19b": [1, 2], "xgeoid20b": [1, 2], "igld85": [1, 2], "lwd_igld85": [1, 2], "ohwm_igld85": [1, 2], "lmsl": [1, 2], "mllw": [1, 2], "mlw": [1, 2], "mtl": [1, 2], "dtl": [1, 2], "mhw": [1, 2], "mhhw": [1, 2], "lwd": [1, 2], "nad27": [1, 2], "nad83_1986": [1, 2], "nad83_2011": [1, 2], "nad83_nsrs2007": [1, 2], "nad83_marp00": [1, 2], "nad83_pacp00": [1, 2], "wgs84_g1674": [1, 2], "itrf2014": [1, 2], "igs14": [1, 2], "itrf2008": [1, 2], "igs08": [1, 2], "itrf2005": [1, 2], "igs2005": [1, 2], "wgs84_g1150": [1, 2], "itrf2000": [1, 2], "igs00": [1, 2], "igb00": [1, 2], "itrf96": [1, 2], "wgs84_g873": [1, 2], "itrf94": [1, 2], "itrf93": [1, 2], "itrf92": [1, 2], "siomit92": [1, 2], "wgs84_g730": [1, 2], "itrf91": [1, 2], "itrf90": [1, 2], "itrf89": [1, 2], "itrf88": [1, 2], "wgs84_transit": [1, 2], "wgs84_g1762": [1, 2], "wgs84_g2139": [1, 2], "vertic": [1, 2], "frame": 1, "index": [1, 2, 3, 6, 7], "search": [1, 2, 3, 6, 7], "page": [1, 2, 3, 6, 7], "back": [1, 2, 6, 7], "top": [1, 2, 6, 7], "lat": [2, 5, 6, 7], "float": [2, 5, 7], "lon": [2, 5, 6, 7], "str": [2, 7], "liter": [2, 7], "none": [2, 5, 7], "from_model": [2, 5, 6], "from_vr": 2, "cr": 2, "from_wkt": 2, "from_epsg": 2, "int": [2, 7], "paramet": [2, 6, 7], "decim": [2, 7], "latitud": [2, 7], "longitud": [2, 7], "see": [2, 3, 7], "available_region": 2, "pyproj": [2, 4], "is_vert": 2, "must": [2, 5], "true": 2, "main": 2, "sub": 2, "well": 2, "known": 2, "text": 2, "get": [2, 7], "vr": [2, 7], "epsg": 2, "code": [2, 4, 7], "as_dict": 2, "dict": [2, 7], "return": [2, 6, 7], "json": [2, 7], "object": [2, 5], "__dict__": 2, "type": [2, 7], "as_float": 2, "__float__": 2, "exist": 2, "as_str": 2, "string": 2, "__str__": 2, "available_model": 2, "avail": 2, "usabl": 2, "doc": 2, "comput": 2, "given": [2, 7], "Will": 2, "set": [2, 4, 7], "self": 2, "variabl": 2, "suppli": [2, 5], "final": 2, "call": 2, "get_height": 2, "valid": [2, 7], "can": [2, 4, 5], "found": [2, 7], "here": [1, 2], "wkt": 2, "in_cm": 2, "centimet": 2, "cm": 2, "in_feet": 2, "imperi": 2, "foot": 2, "u": [2, 6, 7], "survei": [2, 7], "feet": [2, 7], "in_feet_us_survei": [2, 5], "0": [2, 4], "999998": 2, "ft": 2, "usft": 2, "verify_model": 2, "bool": 2, "term": [2, 7], "phrase": 2, "contain": [2, 7], "name": [2, 7], "ex": 2, "correctli": 2, "format": 2, "queri": [2, 5, 7], "http": [3, 4], "github": [3, 4], "com": [3, 4], "iannesbitt": [3, 4], "ian": 3, "nesbitt": 3, "ucsb": 3, "For": 3, "more": [2, 3], "inform": 3, "about": 3, "section": 3, "instal": 3, "pip": 3, "conda": 3, "def": [3, 7], "test": 3, "util": [3, 5], "get_ngs_json": [3, 7], "get_ngs_url": [3, 7], "get_vdatum_json": [3, 7], "get_vdatum_url": [3, 7], "request": 4, "pyegt": 4, "onli": 4, "depend": 4, "To": 4, "creat": 4, "your": 4, "virtual": 4, "environ": 4, "run": [4, 6], "anaconda": 4, "miniconda": 4, "packag": 4, "itself": 4, "specif": [4, 5], "channel": 4, "c": 4, "new": 4, "latest": 4, "commit": 4, "manual": 4, "execut": 4, "git": 4, "clone": 4, "cd": 4, "Or": 4, "directli": [2, 4], "design": 5, "easi": 5, "simpli": 5, "initi": 5, "datum": 5, "against": 5, "import": [2, 5, 6], "44": [5, 6], "256616": [5, 6], "73": [5, 6], "964784": [5, 6], "28": [5, 6], "157": [5, 6], "meter": [2, 5], "92": 5, "37842416572809": 5, "also": 5, "899": [5, 6], "argument": 5, "If": [5, 6], "user": 5, "default": 5, "highli": 5, "doe": 5, "Its": 5, "sole": 5, "locat": [2, 5], "try": [], "pr": 6, "coordin": 6, "ngs_url": 7, "applic": 7, "url": 7, "vdatum_url": 7, "definit": 1, "model_search": [3, 7], "rais": [2, 7], "attributeerror": [2, 7], "geoidheight": 7, "connectionerror": 7, "tri": 7, "respons": 7, "error": [6, 7], "egm": 7, "bad_nam": 7, "navd": 7, "88": 7, "A": 7, "verifi": 7, "indic": [2, 7], "describ": [1, 2], "64": [2, 6], "486036": 6, "165": [2, 6], "292154": 6, "18": 6, "47131": 6, "66": 6, "136544": 6, "expect": 6, "expected_valu": 6, "43": 6, "285": 6, "005": 6, "45": 6, "473": 6, "construct": 7, "servic": 7, "model_list": [1, 3, 7], "valueerror": 2, "match": 2, "100": 2, "than": 2, "one": 2, "invalid": 7, "ani": 6, "fail": 6, "script": 6, "exit": 6, "after": 6, "print": 6, "result": 6, "full": 1, "amalgam": [], "both": [], "concaten": 1, "repres": 2, "__eq__": 2, "_heightmodel__valu": 2, "math": 2, "isclos": 2, "compar": 2, "point": 2, "alwai": 2, "boolean": 2, "equal": 2, "two": 2, "__repr__": 2, "printabl": 2, "represent": 2, "506181": 2, "399282": 2, "repr": 2, "998": 2}, "objects": {"pyegt": [[1, 0, 0, "-", "defs"], [2, 0, 0, "-", "height"], [6, 0, 0, "-", "test"], [7, 0, 0, "-", "utils"]], "pyegt.defs": [[1, 1, 1, "", "MODEL_LIST"], [1, 1, 1, "", "NGS_MODELS"], [1, 1, 1, "", "REGIONS"], [1, 1, 1, "", "VDATUM_MODELS"]], "pyegt.height": [[2, 2, 1, "", "HeightModel"]], "pyegt.height.HeightModel": [[2, 3, 1, "", "__eq__"], [2, 3, 1, "", "__float__"], [2, 3, 1, "", "__repr__"], [2, 3, 1, "", "__str__"], [2, 3, 1, "", "as_dict"], [2, 3, 1, "", "as_float"], [2, 3, 1, "", "as_string"], [2, 3, 1, "", "available_models"], [2, 3, 1, "", "available_regions"], [2, 3, 1, "", "from_epsg"], [2, 3, 1, "", "from_model"], [2, 3, 1, "", "from_vrs"], [2, 3, 1, "", "from_wkt"], [2, 3, 1, "", "get_height"], [2, 3, 1, "", "in_cm"], [2, 3, 1, "", "in_feet"], [2, 3, 1, "", "in_feet_us_survey"], [2, 3, 1, "", "verify_model"]], "pyegt.test": [[6, 4, 1, "", "test"]], "pyegt.utils": [[7, 4, 1, "", "get_ngs_json"], [7, 4, 1, "", "get_ngs_url"], [7, 4, 1, "", "get_vdatum_json"], [7, 4, 1, "", "get_vdatum_url"], [7, 4, 1, "", "model_search"]]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:method", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "function", "Python function"]}, "titleterms": {"about": 0, "pyegt": [0, 1, 2, 3, 5, 6, 7], "def": 1, "height": 2, "0": 3, "1": 3, "resourc": 3, "librari": 3, "lookup": 3, "instal": 4, "pip": 4, "conda": 4, "from": 4, "sourc": 4, "us": 5, "test": 6, "util": 7, "2": 3}, "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.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"About pyegt": [[0, "about-pyegt"]], "pyegt 0.1.2": [[3, "pyegt-version"]], "Resources": [[3, null]], "Library": [[3, null]], "Lookups": [[3, "lookups"]], "Installation": [[4, "installation"]], "pip": [[4, "pip"]], "conda": [[4, "conda"]], "From source": [[4, "from-source"]], "Using pyegt": [[5, "using-pyegt"]], "pyegt.utils": [[7, "module-pyegt.utils"]], "pyegt.defs": [[1, "module-pyegt.defs"]], "pyegt.test": [[6, "module-pyegt.test"]], "pyegt.height": [[2, "module-pyegt.height"]]}, "indexentries": {"heightmodel (class in pyegt.height)": [[2, "pyegt.height.HeightModel"]], "__eq__() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.__eq__"]], "__float__() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.__float__"]], "__repr__() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.__repr__"]], "__str__() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.__str__"]], "as_dict() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.as_dict"]], "as_float() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.as_float"]], "as_string() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.as_string"]], "available_models() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.available_models"]], "available_regions() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.available_regions"]], "from_epsg() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.from_epsg"]], "from_model() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.from_model"]], "from_vrs() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.from_vrs"]], "from_wkt() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.from_wkt"]], "get_height() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.get_height"]], "in_cm() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.in_cm"]], "in_feet() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.in_feet"]], "in_feet_us_survey() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.in_feet_us_survey"]], "module": [[2, "module-pyegt.height"]], "pyegt.height": [[2, "module-pyegt.height"]], "verify_model() (pyegt.height.heightmodel method)": [[2, "pyegt.height.HeightModel.verify_model"]]}})
\ No newline at end of file
diff --git a/docsrc/_build/html/utils.html b/docsrc/_build/html/utils.html
index 99cc2a6..2ffc0f3 100644
--- a/docsrc/_build/html/utils.html
+++ b/docsrc/_build/html/utils.html
@@ -110,7 +110,7 @@
- Raises:
-
@@ -158,6 +158,7 @@
-
diff --git a/docsrc/defs.rst b/docsrc/defs.rst
index 0ce9875..e0bc17d 100644
--- a/docsrc/defs.rst
+++ b/docsrc/defs.rst
@@ -4,6 +4,30 @@
.. automodule:: pyegt.defs
:members:
+.. py:data:: MODEL_LIST
+ :type: list
+
+ The full list of models from NGS and VDatum APIs described here,
+ concatenated from :py:data:`pyegt.defs.NGS_MODELS` and
+ :py:data:`pyegt.defs.VDATUM_MODELS`::
+
+ MODEL_LIST = [
+ 'GEOID99', 'G99SSS', 'GEOID03', 'USGG2003', 'GEOID06', 'USGG2009',
+ 'GEOID09', 'XUSHG', 'USGG2012', 'GEOID12A', 'GEOID12B', 'GEOID18',
+ 'NAVD88', 'NGVD29', 'ASVD02', 'W0_USGG2012', 'GUVD04', 'NMVD03',
+ 'PRVD02', 'VIVD09', 'CRD', 'EGM2008', 'EGM1996', 'EGM1984',
+ 'XGEOID16B', 'XGEOID17B', 'XGEOID18B', 'XGEOID19B', 'XGEOID20B',
+ 'IGLD85', 'LWD_IGLD85', 'OHWM_IGLD85', 'CRD', 'LMSL', 'MLLW',
+ 'MLW', 'MTL', 'DTL', 'MHW', 'MHHW', 'LWD', 'NAD27', 'NAD83_1986',
+ 'NAD83_2011', 'NAD83_NSRS2007', 'NAD83_MARP00', 'NAD83_PACP00',
+ 'WGS84_G1674', 'ITRF2014', 'IGS14', 'ITRF2008', 'IGS08',
+ 'ITRF2005', 'IGS2005', 'WGS84_G1150', 'ITRF2000', 'IGS00', 'IGb00',
+ 'ITRF96', 'WGS84_G873', 'ITRF94', 'ITRF93', 'ITRF92', 'SIOMIT92',
+ 'WGS84_G730', 'ITRF91', 'ITRF90', 'ITRF89', 'ITRF88',
+ 'WGS84_TRANSIT', 'WGS84_G1762', 'WGS84_G2139'
+ ]
+
+
................
* :ref:`genindex`
diff --git a/docsrc/height.rst b/docsrc/height.rst
index 2e5bef5..d507802 100644
--- a/docsrc/height.rst
+++ b/docsrc/height.rst
@@ -3,6 +3,7 @@
.. automodule:: pyegt.height
:members:
+ :special-members: __dict__, __eq__, __float__, __repr__, __str__
................
diff --git a/pyegt/defs.py b/pyegt/defs.py
index 557b83e..0f3a698 100644
--- a/pyegt/defs.py
+++ b/pyegt/defs.py
@@ -26,10 +26,12 @@
'GEOID12B': 13,
'GEOID18': 14,
}
-""".. |ngsafg| raw:: html
+"""
+.. |ngsafg| raw:: html
NOAA NGS API for Geoid
+
Geoid model numbers used in the NGS API.
From |ngsafg|.
@@ -105,5 +107,4 @@
for m in VDATUM_MODELS:
MODEL_LIST.append(m)
"""
-The full list of models from NGS and VDatum APIs described here.
"""
diff --git a/pyegt/height.py b/pyegt/height.py
index 73e7457..97f7518 100644
--- a/pyegt/height.py
+++ b/pyegt/height.py
@@ -219,7 +219,7 @@ def get_height(self) -> float:
def in_feet_us_survey(self) -> float:
"""
- Convert to US survey foot (for imperial feet use `in_feet()`).
+ Convert to US survey foot (for imperial feet use ``in_feet()``).
1 imperial foot = 0.999998 US survey feet
:return: Height value in usft (if it exists)
@@ -230,7 +230,7 @@ def in_feet_us_survey(self) -> float:
def in_feet(self) -> float:
"""
- Convert to imperial foot (for US survey feet use `in_feet_us_survey()`).
+ Convert to imperial foot (for US survey feet use ``in_feet_us_survey()``).
1 imperial foot = 0.999998 US survey feet
:return: Height value in ft (if it exists)
@@ -265,7 +265,7 @@ def as_string(self) -> str:
"""
Convert to string using ``__str__``.
- :return:
+ :return: The height value in meters represented in string format
:rtype: str
"""
return self.__str__()
@@ -357,8 +357,9 @@ def as_dict(self) -> dict:
def __eq__(self, __value: object) -> bool:
"""
- Use `math.isclose()` to compare as floating point numbers are not always directly comparable.
+ Use :py:func:`math.isclose()` to compare as floating point numbers are not always directly comparable.
+ :meta public:
:return: Boolean equality of two floats
:rtype: bool
:raises ValueError: if no ``self.height`` value exists
diff --git a/pyegt/utils.py b/pyegt/utils.py
index 1da0a61..aa6bdd7 100644
--- a/pyegt/utils.py
+++ b/pyegt/utils.py
@@ -50,7 +50,7 @@ def get_ngs_json(ngs_url: str) -> dict:
:return: The returned json (if applicable)
:rtype: json
:raises AttributeError: if geoidHeight is not in returned json
- :raises ConnectionError: if no NGS json is returned in 3 tries
+ :raises ConnectionError: if no NGS JSON is returned in 3 tries
"""
i = 0
while True:
@@ -101,7 +101,9 @@ def get_vdatum_json(vdatum_url, region) -> dict:
:rtype: dict
:raises AttributeError: if the returned JSON has an error indicating the set region is invalid
:raises AttributeError: if the returned JSON has a generic error code
+ :raises ConnectionError: if no VDatum JSON is returned in 3 tries
"""
+ i = 0
while True:
print('Querying %s' % (vdatum_url))
response = requests.get(vdatum_url)
@@ -113,6 +115,11 @@ def get_vdatum_json(vdatum_url, region) -> dict:
raise AttributeError('Region "%s" is not valid!' % (region))
else:
raise AttributeError('VDatum API error %s: %s' % (json_data['errorCode'], json_data['message']))
+ if i < 3:
+ i += 1
+ time.sleep(1)
+ else:
+ raise ConnectionError('Could not get NGS json in %s tries.' % (i))
"""def adjustment(user_vrs: Union[str, Literal[None]]=None,
las_vrs: Union[str, Literal[None]]=None, # overrides user_vrs.
|
|
|
|