Skip to content
Snippets Groups Projects
Normal view Permalink
searchindex.js 14.7 KiB
Newer Older
Jeremy Auclair's avatar
Updated sphinx documentation. Changed some function docstrings  
Jeremy Auclair committed
1 
Search.setIndex({"docnames": ["index", "inputs/input_preparation", "inputs/land_cover", "inputs/ndvi_cube", "inputs/samir_params", "inputs/soil_data", "inputs/weather_cube", "samir/data_and_ram_management", "samir/run_samir", "samir/samir_functions", "setup/conda_env", "setup/json_config_file", "setup/setup"], "filenames": ["index.rst", "inputs/input_preparation.rst", "inputs/land_cover.rst", "inputs/ndvi_cube.rst", "inputs/samir_params.rst", "inputs/soil_data.rst", "inputs/weather_cube.rst", "samir/data_and_ram_management.rst", "samir/run_samir.rst", "samir/samir_functions.rst", "setup/conda_env.rst", "setup/json_config_file.rst", "setup/setup.rst"], "titles": ["ModSpa-Pixel", "Preparing the inputs for Modspa-Pixel", "Preparing the land cover raster", "Preparing the NDVI data cube", "Preparing the SAMIR parameter csv file", "Preparing the soil data raster", "Preparing the weather data cube", "Good practices to use the SAMIR model", "Run the SAMIR model", "How the SAMIR functions works", "Installing the conda environnment", "Understanding the json config file", "Setting up the correct environnment and parameters"], "terms": {"index": [0, 3], "modul": [0, 3, 11], "search": 0, "page": [0, 12], "thi": [0, 1, 3, 10, 11, 12], "project": [0, 1, 10, 12], "i": [0, 1, 3, 10, 11, 12], "under": [0, 11], "activ": [0, 3, 10], "develop": [0, 12], "set": [0, 11], "up": [0, 3, 11], "correct": [0, 1, 3, 10, 11], "environn": 0, "paramet": [0, 1, 3, 9, 10, 11], "run": [0, 1, 9, 10, 11, 12], "samir": [0, 1, 11], "model": [0, 1, 9, 11], "prepar": [0, 9], "input": [0, 3, 9, 10, 11], "instal": [0, 12], "conda": [0, 12], "understand": [0, 12], "json": [0, 3, 9, 12], "config": [0, 3, 9, 12], "file": [0, 1, 3, 9, 10, 12], "ndvi": [0, 1, 9, 11], "data": [0, 1, 11], "cube": [0, 1, 9, 11], "weather": [0, 1, 3, 9, 11], "land": [0, 1, 9, 11], "cover": [0, 1, 3, 9, 11], "raster": [0, 1, 9], "soil": [0, 1, 9, 11], "csv": [0, 1, 3, 9], "good": [0, 3, 8], "practic": [0, 8], "us": [0, 3, 8, 10, 11], "how": [0, 8, 11], "function": [0, 3, 8], "work": [0, 8, 12], "an": [0, 3, 11], "adapt": 0, "exist": [0, 3], "http": [10, 12], "gitlab": 12, "cesbio": 12, "omp": 12, "eu": 12, "modelis": 0, "process": [0, 1, 3, 11], "chain": [0, 1, 3, 11], "It": [0, 3, 4], "mix": 0, "satellit": [0, 11], "optic": [0, 1, 11], "like": [0, 12], "safi": [0, 1], "_onli": [], "current": [0, 3, 9, 11, 12], "supported_": [], "spatial": [0, 1, 11], "The": [0, 1, 3, 4, 10, 11], "previou": [0, 3, 9], "version": [0, 3, 10, 11, 12], "panda": [0, 4], "datafram": [0, 4], "parcel": [0, 11], "scale": [0, 3, 9], "ar": [0, 1, 3, 9, 11], "aggreg": 0, "numpi": [0, 9], "allow": [0, 3, 4, 11], "higher": [0, 11], "resolut": [0, 3], "cost": 0, "increas": 0, "storag": 0, "calcul": [0, 9, 11], "requir": [0, 1, 3], "onli": [0, 3], "support": [0, 3, 11], "modspa_pixel": [3, 4, 9, 10, 11, 12], "code": [9, 11], "modspa_samir": 9, "run_samir": [8, 9], "json_config_fil": 9, "str": [3, 4, 9, 11], "csv_param_fil": 9, "ndvi_cube_path": [3, 9], "weather_path": 9, "soil_params_path": 9, "land_cover_path": 9, "save_path": [3, 9], "additional_output": 9, "dict": [3, 9], "none": [3, 9], "available_ram": 9, "int": [3, 9, 11], "8": [9, 10], "sourc": [3, 4, 9], "call": [3, 9], "samir_daili": [8, 9], "argument": [], "1": [3, 4], "path": [3, 9, 11], "output": [9, 11], "save": [3, 9, 11], "default": [3, 4, 9, 10], "dictionnari": [3, 9], "contain": [3, 4, 9], "optionn": 9, "addit": 9, "avail": 9, "ram": [3, 9, 11], "gib": [9, 11], "return": [], "ndarrai": 9, "et0": 9, "rain": 9, "wfc": 9, "wwp": 9, "param": 9, "dr0": 9, "dd0": 9, "zr0": 9, "e0": 9, "tr0": 9, "dei0": 9, "dep0": 9, "idai": 9, "tupl": 9, "singl": 9, "dai": [3, 9], "compil": 9, "numba": 9, "intermediari": 9, "np": 9, "field": 9, "capac": 9, "wilt": 9, "point": 9, "factor": 9, "root": [9, 10], "layer": 9, "deplet": 9, "deep": 9, "depth": 9, "surfac": [3, 9], "evapor": 9, "plant": 9, "transpir": 9, "irrig": 9, "part": [3, 9, 11], "precipit": 9, "loop": 9, "counter": 9, "current_day_outout": 9, "multipl": [4, 9], "arrai": 9, "frac": 3, "nir": 3, "red": 3, "samir_paramet": 4, "class": 4, "params_samir_class": 4, "paramfil": 4, "load": 4, "all": [1, 3, 4, 10, 11], "one": [3, 4, 10], "object": 4, "ha": [3, 4, 11], "attribut": 4, "tabl": 4, "paramt": [4, 11], "row": 4, "column": 4, "also": [3, 4, 11], "scale_factor": 4, "first": [1, 3, 4], "convert": [3, 4], "integ": [3, 4], "valu": [3, 4, 10], "reduc": 4, "memori": [4, 11], "usag": 4, "second": 4, "fill": 4, "miss": [4, 10], "exampl": [3, 4, 10, 11], "class1": 4, "class2": 4, "class3": 4, "classnam": 4, "classnumb": 4, "0": [3, 4, 10, 11], "00": 4, "2": [3, 4, 11], "000": 4, "3": 4, "fminndvi": 4, "1000": 4, "20": [3, 4], "100": [3, 4], "fmaxndvi": 4, "90": 4, "900": 4, "fminfc": 4, "fmaxfc": 4, "fslope": 4, "40": 4, "50": 4, "500": [3, 4], "foffset": 4, "10": [3, 4], "plateau": 4, "70": 4, "kminndvi": 4, "kmaxndvi": 4, "kminkcb": 4, "kmaxkcb": 4, "98": 4, "kslope": 4, "60": 4, "600": 4, "koffset": 4, "zsoil": 4, "2000": 4, "1600": 4, "1550": 4, "kcmax": 4, "15": 4, "fc_stop": 4, "start_date_irr": 4, "p_trigger": 4, "help": [10, 12], "modspa": [11, 12], "pixel": [3, 11, 12], "script": [3, 12], "section": [1, 11, 12], "you": [3, 10, 11, 12], "To": [3, 10, 12], "begin": [3, 12], "clone": 12, "from": [3, 12], "github": 12, "follow": [3, 10, 12], "command": [10, 12], "should": [10, 12], "creat": [3, 10, 11, 12], "directori": [3, 10, 11, 12], "your": [3, 10, 11, 12], "A": [10, 11, 12], "graphic": [11, 12], "interfac": [11, 12], "modifi": [11, 12], "configur": [11, 12], "plan": [11, 12], "later": [3, 11, 12], "cd": [], "directory_where_modspa_project_will_be_loc": [], "git": 12, "auclairj": [11, 12], "thz": 12, "have": [1, 10, 11, 12], "been": 12, "test": [11, 12], "linux": 12, "ubuntu": 12, "oper": [11, 12], "system": 12, "some": [3, 10, 11, 12], "tool": 12, "packag": [10, 12], "might": [3, 10, 12], "other": 12, "window": [1, 3, 11, 12], "mac": 12, "o": 12, "If": 10, "yet": 10, "machin": [3, 10, 11], "start": [10, 11], "step": [3, 10], "link": 10, "yaml": 10, "includ": 10, "automat": [3, 10], "virtual": 10, "librari": 10, "depend": [3, 10, 11], "copi": [], "base": [10, 12], "env": 10, "f": 10, "modspa_pixel_env": 10, "That": 10, "": [3, 10], "otb": 10, "properli": 10, "check": 10, "its": 10, "otbcli_readimageinfo": 10, "error": 10, "wait": 10, "least": 10, "readimageinfo": 10, "applic": 10, "get": [1, 10], "inform": 10, "about": [3, 10], "imag": [3, 10, 11], "complet": [10, 11], "document": 10, "www": 10, "orfeo": 10, "toolbox": 10, "org": 10, "cookbook": 10, "app_readimageinfo": 10, "html": 10, "string": [3, 10], "mandatori": 10, "imagemetadata": 10, "boolean": [3, 10], "displai": 10, "metadata": 10, "fals": [3, 10, 11], "outgeom": 10, "write": [3, 10], "geom": 10, "option": [10, 11], "off": 10, "rgb": 10, "group": 10, "progress": 10, "report": 10, "list": [3, 10], "long": [1, 10, 11], "empti": 10, "given": [3, 10], "kei": 10, "param1": 10, "paramn": 10, "see": 10, "detail": [1, 10, 11], "those": [3, 10], "qb_toulouse_ortho_x": 10, "tif": [3, 10], "free": [3, 10], "invalid": 10, "pointer": 10, "abort": 10, "receiv": 10, "found": [3, 10], "refer": 10, "link_to_conda_instal": 10, "_": [], "random": 10, "link_to_otb_instal": 10, "global": 11, "locat": [3, 11], "config_modspa": 11, "_comment": 11, "sart": 11, "date": [3, 11], "period": 11, "which": [3, 11], "start_dat": [3, 11], "2020": 11, "01": 11, "_comment1": [], "end": [3, 11], "end_dat": [3, 11], "12": 11, "31": 11, "_comment2": [], "shapefil": [3, 11], "path_to_config_fil": [], "home": 11, "eodag": [3, 11], "yml": 11, "_comment3": [], "shapefile_path": 11, "mnt": 11, "e": 11, "scihub": 11, "boundari": 11, "shp": [3, 11], "_comment4": [], "download": [1, 11], "download_path": [3, 11], "_comment5": [], "netcdf": [], "era5": [], "era5_path": [], "_comment9": [], "name": 11, "subdirectori": 11, "log": 11, "run_nam": 11, "_comment10": [], "prefer": 11, "s2": 11, "provid": [3, 11], "choic": 11, "theia": [3, 11], "copernicu": [3, 11], "preferred_provid": [3, 11], "_comment13": [], "overwrit": 11, "true": 11, "want": 11, "rewrit": 11, "take": [3, 11], "longer": 11, "ndvi_overwrit": 11, "_comment14": [], "maximum": [3, 11], "cloud": 11, "percentag": [3, 11], "cloud_cover_limit": [3, 11], "80": [3, 11], "_comment20": [], "max": 11, "number": 11, "processor": 11, "core": 11, "multiprocess": 11, "max_cpu": 11, "choos": [3, 11], "where": [3, 11], "differ": [3, 11], "path_to_shapefil": [], "notebook": [], "sigpac_noguera_2020_id_grup": [], "sentinel": [3, 11], "path_to_eodag_config_fil": 11, "4": [3, 11], "amount": 11, "max_ram": 11, "16": 11, "deokfoef": [], "dzofzoff": [], "fzojozgg": [], "simul": 11, "yyyi": [3, 11], "mm": [3, 11], "dd": [3, 11], "format": [3, 11], "open": [3, 11], "defin": [3, 11], "mode": [1, 11], "delimit": 11, "need": [3, 11], "raw": [1, 11], "each": [1, 11], "type": [3, 11], "imageri": [1, 11], "For": [1, 3, 11], "larg": [1, 11], "over": [1, 3, 11], "time": [1, 3, 11], "make": [1, 11], "sure": [1, 11], "enough": [1, 11], "disk": [1, 3, 11], "space": [1, 3, 11], "preprocess": [1, 11], "carri": 11, "between": [3, 11], "atmospher": 11, "two": [3, 11], "bool": [3, 11], "don": 11, "t": [3, 11], "can": [3, 11], "hour": [3, 11], "more": [3, 11], "filter": [3, 11], "out": 11, "than": [3, 11], "certain": 11, "These": 11, "faster": 11, "bewar": 11, "overload": 11, "wise": 11, "when": 11, "high": [3, 11], "perform": 11, "cluster": 11, "alloc": 11, "veri": [3, 11], "hungri": [3, 11], "lot": 1, "same": 1, "grid": 1, "result": [1, 3], "etc": 1, "normal": 3, "veget": 3, "commonli": 3, "estim": 3, "chang": 3, "through": 3, "doe": 3, "correspond": 3, "physic": 3, "quantiti": 3, "proxi": 3, "biomass": 3, "fact": 3, "low": 3, "reflect": 3, "band": 3, "photosynthet": 3, "radiat": 3, "infrar": 3, "unus": 3, "sun": 3, "light": 3, "spectrum": 3, "usuali": 3, "neg": 3, "water": 3, "bodi": 3, "posit": 3, "highli": 3, "area": 3, "around": 3, "miner": 3, "human": 3, "made": 3, "In": 3, "corr_": 3, "acorvi": 3, "math": [], "appli": 3, "smooth": 3, "extrem": 3, "download_s2": 3, "download_s2_data": 3, "look": 3, "product": 3, "dure": 3, "specif": 3, "whole": 3, "envelopp": 3, "sever": 3, "tile": 3, "chosen": 3, "pass": 3, "befor": 3, "product_path": 3, "specifi": 3, "zip": 3, "tar": 3, "archiv": 3, "extract": 3, "extract_zip_arch": 3, "list_path": 3, "bands_to_extract": 3, "remove_arch": 3, "usual": 3, "match": 3, "b3": 3, "b4": 3, "_b3": 3, "_b4": 3, "architectur": 3, "whether": 3, "remov": 3, "product_list": 3, "delet": 3, "landsat": 3, "ad": 3, "soon": 3, "calculate_ndvi": 3, "extracted_path": 3, "save_dir": 3, "boundary_shapefile_path": 3, "chunk_siz": 3, "x": 3, "4096": 3, "y": 3, "acorvi_corr": 3, "xarrai": 3, "dataset": 3, "uint8": 3, "255": 3, "union": 3, "pre": 3, "geograph": 3, "bound": 3, "meter": 3, "chunk": 3, "size": 3, "dask": 3, "add": 3, "adjust": 3, "interpolate_ndvi": 3, "ndvi_path": 3, "config_fil": 3, "512": 3, "interpol": 3, "daili": 3, "frequenc": 3, "desir": 3, "mean": 3, "dimens": 3, "divid": 3, "along": 3, "axi": 3, "done": 3, "easi": 3, "parallel": 3, "integr": 3, "them": 3, "stack": 3, "dimension": 3, "pre_cub": 3, "netcdf4": 3, "nc": 3, "effici": 3, "read": 3, "limit": 3, "byte": 3, "per": 3, "give": 3, "precis": 3, "lower": 3, "uncertainti": 3, "measur": 3, "littl": 3, "actual": 3, "lost": 3, "onc": 3, "written": 3, "rare": 3, "revisit": 3, "smaller": 3, "5": 3, "final": 3, "both": 3, "ressourc": 3, "cpu": 3}, "objects": {"modspa_pixel.code.modspa_samir": [[9, 0, 1, "", "run_samir"], [9, 0, 1, "", "samir_daily"]], "modspa_pixel.input.calculate_ndvi": [[3, 0, 1, "", "calculate_ndvi"], [3, 0, 1, "", "interpolate_ndvi"]], "modspa_pixel.input.download_S2": [[3, 0, 1, "", "download_S2_data"], [3, 0, 1, "", "extract_zip_archives"]], "modspa_pixel.parameters.params_samir_class": [[4, 1, 1, "", "samir_parameters"]]}, "objtypes": {"0": "py:function", "1": "py:class"}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "class", "Python class"]}, "titleterms": {"welcom": [], "modspa": [0, 1], "pixel": [0, 1], "": [], "document": [], "indic": 0, "tabl": 0, "content": [0, 1, 8, 12], "run": 8, "samir": [4, 7, 8, 9], "model": [7, 8], "set": 12, "up": 12, "correct": 12, "environn": [10, 12], "paramet": [4, 12], "prepar": [1, 2, 3, 4, 5, 6], "input": 1, "instal": 10, "conda": 10, "understand": 11, "json": 11, "config": 11, "file": [4, 11], "land": 2, "cover": 2, "raster": [2, 5], "ndvi": 3, "data": [3, 5, 6], "cube": [3, 6], "csv": 4, "soil": 5, "weather": 6, "good": 7, "practic": 7, "us": 7, "how": 9, "function": 9, "work": 9, "argument": [3, 9], "return": [3, 9], "download": 3, "satellit": 3, "imageri": 3, "calcul": 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.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Preparing the land cover raster": [[2, "preparing-the-land-cover-raster"]], "Preparing the soil data raster": [[5, "preparing-the-soil-data-raster"]], "Preparing the weather data cube": [[6, "preparing-the-weather-data-cube"]], "Preparing the SAMIR parameter csv file": [[4, "preparing-the-samir-parameter-csv-file"]], "ModSpa-Pixel": [[0, "modspa-pixel"]], "Contents:": [[0, null], [8, null], [12, null], [1, null]], "Indices and tables": [[0, "indices-and-tables"]], "Good practices to use the SAMIR model": [[7, "good-practices-to-use-the-samir-model"]], "Run the SAMIR model": [[8, "run-the-samir-model"]], "Installing the conda environnment": [[10, "installing-the-conda-environnment"]], "Setting up the correct environnment and parameters": [[12, "setting-up-the-correct-environnment-and-parameters"]], "Preparing the inputs for Modspa-Pixel": [[1, "preparing-the-inputs-for-modspa-pixel"]], "Understanding the json config file": [[11, "understanding-the-json-config-file"]], "Arguments": [[9, "arguments"], [9, "id1"], [3, "arguments"], [3, "id1"], [3, "id3"], [3, "id5"]], "Returns": [[9, "returns"], [9, "id2"], [3, "returns"], [3, "id2"], [3, "id4"], [3, "id6"]], "How the SAMIR functions works": [[9, "how-the-samir-functions-works"]], "Preparing the NDVI data cube": [[3, "preparing-the-ndvi-data-cube"]], "Download satellite imagery": [[3, "download-satellite-imagery"]], "Calculate NDVI": [[3, "calculate-ndvi"]]}, "indexentries": {"calculate_ndvi() (in module modspa_pixel.input.calculate_ndvi)": [[3, "modspa_pixel.input.calculate_ndvi.calculate_ndvi"]], "download_s2_data() (in module modspa_pixel.input.download_s2)": [[3, "modspa_pixel.input.download_S2.download_S2_data"]], "extract_zip_archives() (in module modspa_pixel.input.download_s2)": [[3, "modspa_pixel.input.download_S2.extract_zip_archives"]], "interpolate_ndvi() (in module modspa_pixel.input.calculate_ndvi)": [[3, "modspa_pixel.input.calculate_ndvi.interpolate_ndvi"]]}})