Newer
Older
Search.setIndex({"docnames": ["file_structure", "filetree", "index", "mode/mode", "mode/parcel", "mode/pixel", "preprocessing/input_preparation", "preprocessing/land_cover", "preprocessing/ndvi_cube", "preprocessing/samir_params", "preprocessing/soil_data", "preprocessing/weather_cube", "samir/data_and_ram_management", "samir/run_samir", "samir/samir_functions", "setup/conda_env", "setup/json_config_file", "setup/setup"], "filenames": ["file_structure.rst", "filetree.rst", "index.rst", "mode/mode.rst", "mode/parcel.rst", "mode/pixel.rst", "preprocessing/input_preparation.rst", "preprocessing/land_cover.rst", "preprocessing/ndvi_cube.rst", "preprocessing/samir_params.rst", "preprocessing/soil_data.rst", "preprocessing/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": ["Project file structure", "<no title>", "ModSpa-Pixel", "Choosing the run mode", "Parcel mode", "Pixel mode", "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 environment", "Understanding the json config file", "Setting up the correct environnment and parameters"], "terms": {"index": [0, 1, 2, 8], "modul": [2, 8, 11, 16], "search": 2, "page": [2, 17], "thi": [2, 3, 6, 7, 8, 9, 11, 15, 16, 17], "project": [2, 3, 6, 7, 8, 11, 15, 17], "i": [0, 2, 3, 6, 7, 8, 9, 11, 15, 16, 17], "under": [2, 16], "activ": [2, 8, 11, 15], "develop": [2, 6, 10, 17], "set": [2, 8, 9, 16], "up": [2, 8, 16], "correct": [2, 3, 6, 7, 8, 11, 15, 16], "environn": [2, 15], "paramet": [0, 1, 2, 6, 7, 8, 10, 14, 15, 16], "run": [2, 6, 7, 8, 11, 14, 15, 16, 17], "samir": [0, 1, 2, 6, 11, 16], "model": [2, 3, 6, 7, 8, 9, 11, 14, 16], "prepar": [2, 3, 14], "input": [2, 3, 7, 8, 10, 11, 14, 15, 16], "instal": [2, 17], "conda": [2, 17], "understand": [2, 17], "json": [0, 1, 2, 3, 8, 9, 11, 17], "config": [0, 1, 2, 3, 8, 11, 17], "file": [2, 3, 6, 7, 8, 10, 11, 14, 15, 17], "ndvi": [2, 3, 6, 7, 11, 14, 16], "data": [2, 3, 6, 7, 9, 16], "cube": [2, 6, 14, 16], "weather": [2, 3, 6, 7, 14, 16], "land": [2, 3, 6, 8, 9, 10, 11, 14, 16], "cover": [2, 3, 6, 8, 9, 10, 11, 14, 16], "raster": [2, 3, 6, 9, 11, 14, 16], "soil": [2, 3, 6, 14, 16], "csv": [0, 1, 2, 6, 8, 11, 14, 16], "good": [2, 8, 13], "practic": [2, 13], "us": [2, 3, 6, 7, 8, 9, 10, 11, 13, 15, 16], "how": [2, 9, 13, 16], "function": [2, 3, 7, 8, 9, 10, 11, 13, 16], "work": [2, 7, 13, 17], "an": [0, 2, 6, 7, 8, 9, 11, 16], "adapt": [2, 9], "exist": [2, 3, 8, 10], "http": [15, 17], "gitlab": 17, "cesbio": 17, "omp": 17, "eu": 17, "modelis": 2, "process": [2, 3, 6, 7, 8, 10, 11, 16], "chain": [2, 6, 8, 11, 16], "It": [2, 8, 9, 11], "mix": 2, "satellit": [2, 16], "optic": [2, 6, 16], "like": [2, 7, 17], "safi": [2, 6, 11], "_onli": [], "current": [0, 2, 6, 7, 8, 14, 16, 17], "supported_": [], "spatial": [2, 6, 9, 11, 16], "The": [2, 3, 6, 7, 8, 10, 11, 15, 16, 17], "previou": [2, 8, 14], "version": [2, 8, 15, 16, 17], "panda": [2, 6, 8, 9, 11], "datafram": [2, 3, 6, 7, 8, 9, 11], "parcel": [0, 1, 2, 3, 6, 16], "scale": [2, 8, 14], "ar": [2, 3, 6, 8, 9, 11, 14, 16], "aggreg": 2, "numpi": [2, 3, 8, 11, 14], "allow": [2, 8, 9, 11, 16], "higher": [2, 11, 16], "resolut": [2, 3, 8, 11, 16], "cost": 2, "increas": 2, "storag": 2, "calcul": [2, 7, 9, 11, 14, 16], "requir": [2, 6, 8, 11, 16], "onli": [2, 3, 8, 10, 11, 16], "support": [2, 8, 16], "modspa_pixel": [3, 7, 8, 9, 11, 14, 15, 16, 17], "code": [8, 16], "modspa_samir": [0, 1, 9, 14], "run_samir": [0, 1, 13, 14], "json_config_fil": [0, 1], "str": [7, 8, 9, 11, 14, 16], "csv_param_fil": 14, "ndvi_cube_path": 14, "weather_path": 14, "soil_params_path": 14, "land_cover_path": [14, 16], "save_path": [7, 8, 11, 14], "additional_output": 14, "dict": [7, 8, 14], "none": [7, 8, 9, 11, 14], "available_ram": [11, 14], "int": [8, 11, 14, 16], "8": [8, 9, 11, 14, 15], "sourc": [0, 1, 7, 8, 9, 11, 14, 16], "call": [8, 11, 14], "samir_daili": [13, 14], "argument": 16, "1": [3, 7, 8, 9, 11, 16], "path": [7, 8, 9, 11, 14, 16], "output": [3, 7, 8, 11, 14, 16], "save": [7, 8, 10, 11, 14, 16], "default": [3, 8, 11, 14, 15, 16], "dictionnari": [7, 8, 9, 14], "contain": [3, 8, 9, 10, 11, 14, 16], "optionn": 7, "addit": [7, 8, 14], "avail": [8, 11, 14], "ram": [8, 11, 14, 16], "gib": [11, 14, 16], "return": [], "ndarrai": [8, 11, 14], "et0": [11, 14], "rain": [11, 14], "wfc": [10, 14], "wwp": 14, "param": 14, "dr0": 14, "dd0": 14, "zr0": 14, "e0": 14, "tr0": 14, "dei0": 14, "dep0": 14, "idai": 14, "tupl": 14, "singl": [7, 8, 10, 11, 14], "dai": [8, 11, 14], "compil": 14, "numba": [3, 14], "intermediari": [8, 14], "np": [8, 11, 14], "field": [3, 10, 14, 16], "capac": [10, 14, 16], "wilt": [10, 14, 16], "point": [10, 14, 16], "factor": [8, 14], "root": [3, 14, 15], "layer": 14, "deplet": 14, "deep": [3, 14], "depth": 14, "surfac": [8, 11, 14], "evapor": [3, 11, 14], "plant": 14, "transpir": [3, 14], "irrig": [3, 14], "part": [7, 8, 14, 16], "precipit": 14, "loop": 14, "counter": 14, "current_day_outout": 14, "multipl": [8, 9, 14, 16], "arrai": [8, 9, 11, 14], "frac": 8, "nir": 8, "red": 8, "samir_paramet": 9, "class": [7, 9, 16], "params_samir_class": [0, 1, 9], "paramfil": 9, "load": 9, "all": [3, 6, 8, 9, 11, 15, 16], "one": [7, 8, 9, 11, 15, 16], "object": [9, 11], "ha": [6, 7, 8, 11, 16], "attribut": [7, 11, 16], "tabl": 9, "paramt": [9, 16], "row": 9, "column": [], "also": [3, 8, 9, 10, 11, 16], "scale_factor": 9, "first": [6, 8, 9, 11], "convert": [3, 7, 8, 9, 10, 11], "integ": [7, 8, 9, 16], "valu": [3, 6, 7, 8, 9, 10, 11, 15, 16], "reduc": [8, 9], "memori": [8, 9, 11, 14, 16], "usag": [8, 9, 14], "second": 9, "fill": [8, 9], "miss": [8, 9, 15], "exampl": [7, 8, 9, 15, 16], "class1": 9, "class2": 9, "class3": 9, "classnam": 9, "classnumb": 9, "0": [8, 9, 11, 15, 16], "00": 9, "2": [3, 7, 8, 9, 11, 16], "000": 9, "3": [8, 9, 16], "fminndvi": 9, "1000": [8, 9, 14], "20": [8, 9, 16], "100": [8, 9, 14], "fmaxndvi": 9, "90": 9, "900": 9, "fminfc": 9, "fmaxfc": 9, "fslope": 9, "40": 9, "50": 9, "500": [8, 9], "foffset": 9, "10": [8, 9, 11, 16], "plateau": 9, "70": [9, 11], "kminndvi": 9, "kmaxndvi": 9, "kminkcb": 9, "kmaxkcb": 9, "98": 9, "kslope": 9, "60": 9, "600": 9, "koffset": 9, "zsoil": 9, "2000": 9, "1600": 9, "1550": 9, "kcmax": 9, "15": 9, "fc_stop": 9, "start_date_irr": 9, "p_trigger": 9, "help": [7, 15, 17], "modspa": [3, 11, 16], "pixel": [0, 1, 3, 16], "script": [3, 6, 7, 8, 9, 17], "section": [6, 8, 16, 17], "you": [7, 8, 9, 10, 15, 16, 17], "To": [8, 15, 17], "begin": [8, 17], "clone": 17, "from": [8, 9, 11, 16, 17], "github": 17, "follow": [8, 9, 10, 11, 15, 16, 17], "command": [7, 11, 15, 17], "should": [7, 9, 10, 15, 16, 17], "creat": [7, 8, 9, 11, 15, 16, 17], "directori": [7, 8, 10, 15, 16, 17], "your": [7, 8, 11, 15, 16, 17], "A": [3, 8, 11, 15, 16, 17], "graphic": [16, 17], "interfac": [16, 17], "modifi": [8, 16, 17], "configur": [8, 9, 11, 16, 17], "plan": [16, 17], "later": [11, 16, 17], "cd": [], "directory_where_modspa_project_will_be_loc": [], "git": [16, 17], "auclairj": [16, 17], "thz": [], "have": [3, 6, 7, 8, 9, 10, 11, 15, 16, 17], "been": 17, "test": [0, 1, 17], "linux": 17, "ubuntu": 17, "oper": [11, 16, 17], "system": 17, "some": [8, 9, 11, 15, 16, 17], "tool": 17, "packag": [8, 15, 17], "might": [8, 15, 17], "other": [7, 9, 10, 11, 17], "window": [6, 8, 11, 16, 17], "mac": 17, "o": 17, "If": [8, 9, 10, 15], "yet": 15, "machin": [8, 15, 16], "start": [7, 8, 11, 15, 16], "step": [8, 15], "link": 15, "yaml": [], "includ": [7, 15], "automat": [7, 8, 11, 15, 16], "virtual": 15, "librari": [8, 15], "depend": [8, 15, 16], "copi": 16, "base": 15, "env": 15, "f": 15, "modspa_pixel_env": [0, 1, 15], "That": 15, "": [8, 11, 15], "otb": [7, 10, 11, 15], "properli": 15, "check": 15, "its": 15, "otbcli_readimageinfo": 15, "error": 15, "wait": 15, "least": 15, "readimageinfo": 15, "applic": [11, 15], "get": [6, 15], "inform": [7, 8, 15], "about": [8, 15], "imag": [7, 8, 11, 15, 16], "complet": [11, 15, 16], "document": [7, 15], "www": 15, "orfeo": 15, "toolbox": 15, "org": 15, "cookbook": 15, "app_readimageinfo": 15, "html": 15, "string": [8, 15], "mandatori": 15, "imagemetadata": 15, "boolean": [8, 11, 15, 16], "displai": 15, "metadata": 15, "fals": [8, 15, 16], "outgeom": 15, "write": [8, 15], "geom": 15, "option": [15, 16], "off": 15, "rgb": 15, "group": 15, "progress": [8, 10, 15], "report": 15, "list": [7, 8, 11, 15, 16], "long": [6, 15, 16], "empti": [9, 15], "given": [3, 8, 9, 11, 14, 15], "kei": [7, 15], "param1": 15, "paramn": 15, "see": 15, "detail": [6, 15, 16], "those": [3, 8, 11, 15], "qb_toulouse_ortho_x": 15, "tif": [7, 8, 11, 15], "free": [8, 15], "invalid": 15, "pointer": 15, "abort": 15, "receiv": 15, "found": [7, 8, 10, 15], "refer": [7, 15], "link_to_conda_instal": [], "_": 9, "random": 15, "link_to_otb_instal": [], "global": [6, 16], "locat": [8, 9, 16], "config_modspa": [0, 1, 16], "_comment": 16, "sart": 16, "date": [3, 6, 8, 11, 16], "period": [11, 16], "which": [7, 8, 9, 11, 16], "start_dat": [8, 11, 16], "2020": [], "01": 16, "_comment1": [], "end": [8, 11, 16], "end_dat": [8, 11, 16], "12": [11, 16], "31": 16, "_comment2": [], "shapefil": [3, 7, 8, 11, 16], "path_to_config_fil": [], "home": 16, "eodag": [8, 16], "yml": [0, 1, 15, 16], "_comment3": [], "shapefile_path": 16, "mnt": 16, "e": [7, 14, 16], "scihub": [], "boundari": 16, "shp": [8, 16], "_comment4": [], "download": [6, 11, 16], "download_path": [8, 16], "_comment5": [], "netcdf": [7, 11, 16], "era5": [11, 16], "era5_path": 16, "_comment9": [], "name": [7, 8, 10, 11, 14, 16], "subdirectori": 16, "log": 16, "run_nam": 16, "_comment10": [], "prefer": 16, "s2": 16, "provid": [8, 16], "choic": 16, "theia": [8, 16], "copernicu": [8, 16], "preferred_provid": [8, 16], "_comment13": [], "overwrit": [8, 16], "true": [8, 11, 16], "want": [7, 16], "rewrit": [8, 16], "take": [8, 9, 11, 16], "longer": [8, 16], "ndvi_overwrit": 16, "_comment14": [], "maximum": [8, 16], "cloud": [8, 16], "percentag": [8, 16], "cloud_cover_limit": [8, 16], "80": [8, 16], "_comment20": [], "max": [8, 11, 16], "number": [3, 7, 8, 11, 14, 16], "processor": [11, 16], "core": [8, 11, 14, 16], "multiprocess": [8, 11, 16], "max_cpu": [8, 16], "choos": [2, 8, 11, 16], "where": [7, 8, 16], "differ": [3, 8, 9, 16], "path_to_shapefil": [], "notebook": [7, 10, 16], "sigpac_noguera_2020_id_grup": [], "sentinel": [7, 8, 11, 16], "path_to_eodag_config_fil": 16, "4": [8, 9, 14], "amount": 16, "max_ram": [11, 16], "16": 16, "deokfoef": [], "dzofzoff": [], "fzojozgg": [], "simul": [3, 9, 16, 17], "yyyi": [8, 11, 16], "mm": [8, 11, 16], "dd": [8, 11, 16], "format": [3, 16], "open": [8, 11, 16], "defin": [8, 16], "mode": [0, 1, 2, 6, 16], "delimit": 16, "need": [8, 9, 11, 16], "raw": [6, 8, 16], "each": [3, 6, 7, 8, 9, 10, 11, 16], "type": [7, 8, 9, 16], "imageri": [6, 16], "For": [6, 7, 8, 9, 16], "larg": [6, 11, 16], "over": [6, 8, 11, 16], "time": [3, 6, 8, 11, 14, 16], "make": [6, 7, 8, 11, 16], "sure": [6, 8, 16], "enough": [6, 8, 16], "disk": [6, 8, 16], "space": [3, 6, 8, 16], "preprocess": [0, 1, 6, 8, 16], "carri": 16, "between": [2, 7, 8, 11, 16], "atmospher": 16, "two": [3, 8, 10, 11, 16], "bool": [8, 11, 16], "don": 16, "t": [8, 16], "can": [2, 3, 7, 8, 9, 10, 11, 16], "hour": [8, 16], "more": [8, 16], "filter": [8, 16], "out": [7, 16], "than": [8, 11, 16], "certain": 16, "These": 16, "faster": [8, 14, 16], "bewar": 16, "overload": 16, "wise": 16, "when": [8, 16], "high": [8, 16], "perform": [16, 17], "cluster": 16, "alloc": 16, "veri": [8, 11, 16], "hungri": [8, 16], "lot": 6, "same": [3, 6, 7, 8, 10, 11], "grid": [3, 6, 7, 10, 11], "result": [6, 7, 8, 10, 11], "etc": 6, "normal": 8, "veget": 8, "commonli": 8, "estim": [8, 11], "chang": [3, 8, 9], "through": 8, "doe": 8, "correspond": [7, 8, 9, 11, 16], "physic": [8, 14], "quantiti": 8, "proxi": 8, "biomass": 8, "fact": 8, "low": [8, 11], "reflect": 8, "band": 8, "photosynthet": 8, "radiat": [8, 11], "infrar": 8, "unus": 8, "sun": 8, "light": 8, "spectrum": 8, "usuali": [], "neg": 8, "water": [3, 8, 11], "bodi": 8, "posit": 8, "highli": 8, "area": [8, 11], "around": 8, "miner": 8, "human": 8, "made": 8, "In": [3, 8, 9, 11], "corr_": 8, "acorvi": 8, "math": 11, "appli": 8, "smooth": 8, "extrem": 8, "download_s2": [0, 1, 8], "download_s2_data": 8, "look": 8, "product": 8, "dure": 8, "specif": 8, "whole": 8, "envelopp": 8, "sever": 8, "tile": 8, "chosen": [7, 8], "pass": 8, "befor": [8, 9], "product_path": 8, "specifi": 8, "zip": 8, "tar": 8, "archiv": 8, "extract": [6, 7, 11], "extract_zip_arch": 8, "list_path": 8, "bands_to_extract": 8, "remove_arch": 8, "usual": [8, 11], "match": 8, "b3": 8, "b4": 8, "_b3": 8, "_b4": 8, "architectur": 8, "whether": 8, "remov": [8, 11], "product_list": 8, "delet": 8, "landsat": 8, "ad": 8, "soon": 8, "calculate_ndvi": [0, 1, 8], "extracted_path": 8, "save_dir": 8, "boundary_shapefile_path": [], "chunk_siz": 8, "x": [7, 8, 11], "4096": [], "y": [7, 8, 11], "acorvi_corr": 8, "xarrai": [7, 8, 11], "dataset": [3, 6, 7, 8, 10, 11, 14, 16], "uint8": 8, "255": 8, "union": [7, 8, 11], "pre": 8, "geograph": [], "bound": [11, 16], "meter": [8, 11, 16], "chunk": 8, "size": 8, "dask": [8, 16], "add": [7, 8], "adjust": 8, "interpolate_ndvi": 8, "ndvi_path": [8, 11], "config_fil": [8, 11], "512": [], "interpol": [7, 8], "daili": [8, 11], "frequenc": 8, "desir": [8, 9], "mean": 8, "dimens": [3, 7, 8, 11], "divid": 8, "along": 8, "axi": 8, "done": [7, 8, 10, 11], "easi": 8, "parallel": 8, "integr": 8, "them": [8, 11], "stack": 8, "dimension": 8, "pre_cub": 8, "netcdf4": [3, 8, 10, 11, 16], "nc": [0, 1, 8, 11, 16], "effici": [8, 11], "read": 8, "limit": [8, 14], "byte": 8, "per": [8, 11, 16], "give": [7, 8], "precis": [8, 9], "lower": 8, "uncertainti": 8, "measur": [8, 11], "littl": 8, "actual": [8, 11], "lost": 8, "onc": [7, 8], "written": [3, 8, 9, 16], "rare": 8, "revisit": 8, "smaller": 8, "5": [8, 9, 11], "final": 8, "both": [3, 8, 10, 16], "ressourc": 8, "cpu": [8, 11, 14], "evapotranspir": [], "variou": 11, "variabl": [3, 7, 8, 10, 16], "structur": [2, 6, 8, 11], "georeferenc": [8, 11], "produc": [8, 11], "necessari": [9, 11, 16], "As": [10, 11], "now": 11, "era": 11, "implement": 11, "world": 11, "simpl": [11, 16], "python": [8, 11, 16], "api": 11, "download_era5_weath": [0, 1, 11], "request_er5_weath": 11, "raw_s2_image_ref": 11, "reanalysi": 11, "concaten": 11, "obtain": [8, 11], "geotiff": [7, 8, 11, 16], "multiband": 11, "unmodifi": 11, "reproject": [7, 10, 11], "precip_fil": [], "et0_fil": [], "No": 11, "special": 11, "crop": 11, "hypothet": 11, "grass": 11, "assum": 11, "height": 11, "m": 11, "fix": 11, "resist": 11, "albedo": 11, "23": 11, "close": 11, "resembl": 11, "extens": [8, 11, 16], "green": 11, "well": [8, 11], "uniform": [10, 11], "grow": 11, "shade": 11, "ground": 11, "eto": 11, "2m_temperatur": 11, "air": 11, "temperatur": 11, "abov": 11, "2m_dewpoint_temperatur": 11, "dewpoint": 11, "surface_solar_radiation_downward": 11, "total": [8, 11, 16], "downward": 11, "solar": 11, "total_precipit": 11, "10m_u_component_of_wind": 11, "north": 11, "south": 11, "wind": 11, "speed": 11, "10m_v_component_of_wind": 11, "east": 11, "west": 11, "main": 11, "sub": 11, "month": [8, 11], "lib_era5_land_pixel": [0, 1, 11], "call_era5land_daily_for_modspa": 11, "float": [7, 8, 11], "output_path": [11, 16], "9": 11, "calculu": 11, "forc": 11, "reanalysis_era5": 11, "surface_net_solar_radi": 11, "surface_pressur": 11, "mean_sea_level_pressur": 11, "potential_evapor": 11, "total_evapor": 11, "snowfal": 11, "box": [11, 16], "demand": 11, "lat_max": 11, "lon_min": 11, "lat_min": 11, "lon_max": 11, "logic": 11, "server": 11, "wg": 11, "84": 11, "lattitud": 11, "longitud": 11, "convers": [3, 11], "et_0": 11, "much": 11, "order": [3, 11], "clip": [7, 11], "superimpos": [7, 11], "advantag": 11, "being": [8, 11], "howev": [2, 11], "handl": [11, 16], "otbcli_superimpos": [7, 11], "era5land_daily_to_yearly_nc": [], "list_era5land_fil": 11, "output_fil": 11, "h": 11, "select": [11, 16], "without": [8, 11], "right": 11, "coordin": 11, "subprocess": [8, 11], "spawn": 11, "receiviv": 11, "half": 11, "temporari": 11, "output_file_rain": 11, "output_file_et0": 11, "calculate_et0_pixel": 11, "pixel_dataset": 11, "lat": 11, "lon": 11, "year": 11, "xr": 11, "latitudin": 11, "longitudin": 11, "et0_valu": 11, "And": 11, "combine_weather2netcdf": 11, "rain_fil": 11, "et0_til": 11, "weather_fil": 11, "dl_s2": [], "__init__": [0, 1, 9], "py": [0, 1, 9, 16], "csv_file": [0, 1, 16], "params_samir_test": [0, 1], "dev_inputs_test": [0, 1], "soil_100": [0, 1], "ndvi_100": [0, 1], "soil_1000": [0, 1], "ndvi_10": [0, 1], "xls_ndvi_10": [0, 1], "xls_ndvi_100": [0, 1], "soil_10": [0, 1], "ndvi_1000": [0, 1], "land_cover_100": [0, 1], "xls_weather_10": [0, 1], "pix_outputs_10": [0, 1], "land_cover_10": [0, 1], "xls_outputs_100": [0, 1], "xls_outputs_10": [0, 1], "xls_weather_1000": [0, 1], "xls_weather_100": [0, 1], "land_cover_1000": [0, 1], "xls_ndvi_1000": [0, 1], "test_samir_dask": [0, 1], "samir_xl": [0, 1], "samirv5_juin2015": [0, 1], "xlsx": [0, 1], "samirpixel_reference_simonneaux2012": [0, 1], "xl": [0, 1], "input_toolbox": [0, 1], "test_s2_one_til": [], "dev_samir_xarrai": [0, 1], "ipynb": [0, 1, 7, 10], "test_samir": [0, 1], "readm": [0, 1], "md": [0, 1], "doc": [0, 1], "samir_param": [0, 1], "rst": [0, 1], "weather_cub": [0, 1], "land_cov": [0, 1, 16], "ndvi_cub": [0, 1], "input_prepar": [0, 1], "soil_data": [0, 1], "conf": [0, 1], "file_structur": [0, 1], "filetre": [0, 1], "txt": [], "templat": [0, 1], "data_and_ram_manag": [0, 1], "samir_funct": [0, 1], "static": [0, 1], "setup": [0, 1], "conda_env": [0, 1], "build": [0, 1, 6, 8, 9], "makefil": [0, 1], "code_toolbox": [0, 1], "tree": [], "here": [0, 7, 9], "outlai": 0, "strucutr": 0, "pd": [7, 8, 9, 11], "manual": 7, "user": [2, 7], "There": 7, "gener": [3, 7, 9, 10, 11], "definit": 7, "identif": [7, 11], "artifici": [], "find": [7, 8], "repres": [7, 16], "valid": [7, 8], "do": [7, 9], "inr": 7, "reference_satellite_imag": 7, "inm": 7, "lc_raster_input": 7, "lc_raster_output": 7, "nn": 7, "g": 7, "stand": 7, "nearest": 7, "neighbor": 7, "thei": 7, "new": 7, "wwc": 10, "scalar": [9, 10], "organis": 9, "class4": 9, "class5": 9, "class6": 9, "class7": 9, "6": [3, 9], "7": [8, 9], "075": [], "kcb_max": [], "24": 9, "ze": 9, "300": [], "init_ru": 9, "87": [], "diff": 9, "diffr": 9, "rew": 9, "minzr": 9, "150": [], "maxzr": 9, "p": 9, "55": 9, "fw": 9, "irrig_auto": 9, "irrig_man": 9, "kcb_stop_irrig": 9, "header": 9, "three": [8, 9], "leftmost": 9, "manag": [3, 9], "cell": 9, "built": [6, 8], "averag": [3, 6, 8], "imput": 6, "parcel_to_pixel": [0, 1, 7, 8, 11], "postprocess": [0, 1], "request": [], "raw_ndvi": [], "filtered_ndvi": 8, "extracted_s2": [], "interp_ndvi": [], "ndvi_s2": [], "extract_ndvi": [0, 1, 8], "still": 2, "era5land_daily_to_yearly_pixel": 11, "output_file_fin": 11, "main_prepare_input": [0, 1], "params_samir_aurade_test": [0, 1, 16], "main_run_samir": [0, 1], "config_modspa_parcel": [], "select_config_modspa": [0, 1, 16], "config_modspa_pixel": [], "custom_input": [], "plot_gif": [], "output_toolbox": [0, 1], "explore_pixel_output": [0, 1], "extra": 8, "better": 8, "discard": 8, "after": [8, 9], "clear": 8, "declar": 8, "available_cpu": 14, "2019": 16, "aurade_test": 16, "aurade_squar": 16, "outpu": 16, "store": [8, 9, 11, 16], "param_csv_fil": 16, "soil_path": 16, "soil_interpol": 16, "aurade_test_new_lc": 16, "either": 16, "dashboard": 16, "brower": 16, "open_brows": 16, "ndvi_precube_path": 8, "_name_ext": [], "config_modspa_name_ext": [], "name_ext": 16, "destin": 16, "updat": 16, "withou": [], "underscor": [], "content": 16, "params_samir_sigpac_test": [0, 1], "sigpac_test": [], "sigpac_test_new_lc": [], "kc_max": [], "rang": [8, 16], "polygon": [8, 11, 16], "open_brow": [], "layout": [], "style": [], "css": [0, 1], "custom": [0, 1, 8], "no_sim": [], "straw_cer": [], "oilse": [], "soi": [], "sunflow": [], "corn": [], "grassland": [], "orchard": [], "vineyard": [], "broadleaf_forest": [], "conifer_forest": [], "heathland": [], "11": [], "suffix": 9, "prefix": 9, "s_": 9, "int16": 9, "1240": 9, "equal": [8, 9], "stai": 9, "associ": 9, "ani": 9, "empi": 9, "05": [], "maxim": 14, "potenti": 14, "outout": 14, "params_samir_test_dev": [0, 1], "parameter_estim": [0, 1], "lprof": [], "samirxls_reference_readandplot": [0, 1], "samirxls_refer": [0, 1], "fr": [0, 1], "lam2019": [0, 1], "fcmax": 9, "10000": 9, "4286": 9, "214": 9, "5714": 9, "386": 9, "ndvisol": 9, "ndvimax": 9, "85": 9, "3000": 9, "64": 9, "params_samir_min_max": [0, 1], "class_convers": [0, 1], "plot_parcel_gif": [0, 1], "pixel_to_parcel": [0, 1], "plot_pixel_gif": [0, 1], "scaling_dict": 14, "dp": 14, "irr": 14, "swce": 14, "swcr": 14, "tr": 14, "nomin": 14, "perfeclti": 3, "overlap": 3, "independ": 3, "vector": 3, "datacub": 3, "zone": 3, "percol": 3, "additionn": 3, "origin": [3, 8], "geometri": [3, 8, 11], "wai": [], "ouput": [3, 7, 8, 11], "back": 3, "plot": 3, "analysi": 3, "choosen": 3, "rest": 3, "class_conversion_parcel": [0, 1], "custom_inputs_pixel": [0, 1, 7, 10], "custom_inputs_parcel": [0, 1, 7, 10], "explore_parcel_output": [0, 1], "similar": [8, 11], "era5land_daily_to_yearly_parcel": 11, "108": 11, "zonal": [8, 11], "directli": [8, 11], "extract_weather_datafram": 11, "rain_path": 11, "et0_path": 11, "merg": 11, "extract_rasterstat": 11, "geopanda": [7, 11], "iter": [8, 11], "featur": [8, 11], "id": [8, 11], "everi": [8, 11], "rel": 11, "landcov": 11, "lc": 11, "identifi": 11, "agreg": 11, "raster_path": 11, "raster_stat": 11, "convert_dataframe_to_xarrai": [8, 11], "dataframe_in": [8, 11], "data_typ": [7, 8, 11], "time_dimens": [8, 11], "poygon": [7, 8, 11], "3d": [8, 11], "2d": [7, 8, 11], "element": [7, 8, 11], "put": [7, 8, 11], "datatyp": [7, 8, 11], "indic": [8, 11], "parcel_shapefile_var": 16, "etr": 16, "convert_geodataframe_to_xarrai": 7, "geodataframe_in": 7, "geodatafram": 7, "global_attribut": 7, "geodatadram": 7, "dataarrai": 7, "gpd": 7, "no_data": 8, "calculate_ndvi_parcel": 8, "acorvi_correct": 8, "scene": 8, "classif": 8, "mask": 8, "keep": 8, "snow": 8, "unclassifi": 8, "erron": 8, "parrent": 8, "_ndvi": 8, "alreadi": 8, "fil": 8, "won": 8, "again": 8, "calculate_ndvi_imag": 8, "tqdm": 8, "p_tqdm": 8, "bar": 8, "pool": 8, "bigger": 8, "stabil": 8, "parent": 8, "serv": 8, "purpos": 8, "write_geotiff": 8, "transform": 8, "rasterio": 8, "containg": 8, "geotransform": 8, "geo": 8, "epsg": 8, "kept": 8, "rewritten": 8, "unless": 8, "most": 8, "anoth": 8, "design": 8, "portion": 8, "runtim": 8, "statist": 8, "extract_ndvi_stat": 8, "save_raw_dataframe_path": 8, "buffer_dist": 8, "count": 8, "rasterstat": 8, "zonal_stat": 8, "method": 8, "extract_ndvi_imag": 8, "distanc": 8, "buffer": 8, "prevent": 8, "entir": 8, "ndvi_datafram": 8, "too": 8, "few": 8, "filter_raw_ndvi": 8, "ndvi_raw_datafram": 8, "save_filtered_dataframe_path": 8, "min_pixel_ratio": 8, "further": 8, "ident": 8, "collect": 8, "taken": 8, "enter": 8, "minimum": 8, "ratio": 8, "accord": 8, "clean": 8, "flag": 8, "anorm": 8, "timestep": 8, "funcion": 8, "interpolate_ndvi_parcel": 8, "interp_method": 8, "linear": 8, "threshold_ratio_deriv": 8, "25": 8, "threshold_median": 8, "median_window": 8, "last": 8, "possibl": 8, "pchip": 8, "interpolated_datafram": 8, "One": 16, "environ": [2, 17], "regular": 16}, "objects": {"modspa_pixel.parameters.params_samir_class": [[9, 0, 1, "", "samir_parameters"]], "modspa_pixel.parameters.params_samir_class.samir_parameters": [[9, 1, 1, "", "__init__"]], "modspa_pixel.preprocessing.calculate_ndvi": [[8, 2, 1, "", "calculate_ndvi"], [8, 2, 1, "", "calculate_ndvi_image"], [8, 2, 1, "", "calculate_ndvi_parcel"], [8, 2, 1, "", "interpolate_ndvi"], [8, 2, 1, "", "write_geotiff"]], "modspa_pixel.preprocessing.download_ERA5_weather": [[11, 2, 1, "", "request_ER5_weather"]], "modspa_pixel.preprocessing.download_S2": [[8, 2, 1, "", "download_S2_data"], [8, 2, 1, "", "extract_zip_archives"]], "modspa_pixel.preprocessing.extract_ndvi": [[8, 2, 1, "", "extract_ndvi_stats"], [8, 2, 1, "", "filter_raw_ndvi"], [8, 2, 1, "", "interpolate_ndvi_parcel"]], "modspa_pixel.preprocessing.lib_era5_land_pixel": [[11, 2, 1, "", "calculate_ET0_pixel"], [11, 2, 1, "", "call_era5land_daily_for_MODSPA"], [11, 2, 1, "", "combine_weather2netcdf"], [11, 2, 1, "", "era5Land_daily_to_yearly_parcel"], [11, 2, 1, "", "era5Land_daily_to_yearly_pixel"], [11, 2, 1, "", "extract_rasterstats"], [11, 2, 1, "", "extract_weather_dataframe"]], "modspa_pixel.preprocessing.parcel_to_pixel": [[8, 2, 1, "", "convert_dataframe_to_xarray"], [7, 2, 1, "", "convert_geodataframe_to_xarray"]], "modspa_pixel.source.modspa_samir": [[14, 2, 1, "", "run_samir"], [14, 2, 1, "", "samir_daily"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "function", "Python function"]}, "titleterms": {"welcom": [], "modspa": [2, 6], "pixel": [2, 5, 6, 7, 8, 11], "": [], "document": [], "indic": 2, "tabl": 2, "content": [2, 3, 6, 13, 17], "run": [3, 13], "samir": [9, 12, 13, 14], "model": [12, 13], "set": 17, "up": 17, "correct": 17, "environn": 17, "paramet": [9, 17], "prepar": [6, 7, 8, 9, 10, 11], "input": 6, "instal": 15, "conda": 15, "understand": 16, "json": 16, "config": 16, "file": [0, 9, 16], "land": 7, "cover": 7, "raster": [7, 10], "ndvi": 8, "data": [8, 10, 11], "cube": [8, 11], "csv": 9, "soil": 10, "weather": 11, "good": 12, "practic": 12, "us": 12, "how": 14, "function": 14, "work": 14, "argument": [7, 8, 9, 11, 14], "return": [7, 8, 11, 14], "download": 8, "satellit": 8, "imageri": 8, "calcul": 8, "precipit": 11, "refer": 11, "evapotranspir": 11, "inform": 11, "request": 11, "variabl": 11, "format": [8, 11], "preprocess": [7, 10, 11], "raw": 11, "project": 0, "structur": 0, "tree": [], "attribut": 9, "method": 9, "parcel": [4, 7, 8, 11], "mode": [3, 4, 5, 7, 8, 11], "The": 9, "name": 9, "scale": 9, "factor": 9, "default": 9, "column": 9, "choos": 3, "pack": [8, 11], "arg": [8, 11], "tupl": [8, 11], "extract": 8, "environ": 15}, "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": {"Good practices to use the SAMIR model": [[12, "good-practices-to-use-the-samir-model"]], "Run the SAMIR model": [[13, "run-the-samir-model"]], "Contents:": [[13, null], [6, null], [2, null], [3, null], [17, null]], "Preparing the inputs for Modspa-Pixel": [[6, "preparing-the-inputs-for-modspa-pixel"]], "ModSpa-Pixel": [[2, "modspa-pixel"]], "Indices and tables": [[2, "indices-and-tables"]], "Arguments": [[9, "arguments"], [11, "arguments"], [11, "id1"], [11, "id3"], [11, "id5"], [11, "id7"], [11, "id9"], [11, "id11"], [11, "id14"], [14, "arguments"], [14, "id1"], [7, "arguments"], [8, "arguments"], [8, "id1"], [8, "id3"], [8, "id5"], [8, "id7"], [8, "id10"], [8, "id12"], [8, "id14"], [8, "id16"], [8, "id18"]], "Preparing the SAMIR parameter csv file": [[9, "preparing-the-samir-parameter-csv-file"]], "The parameter name": [[9, "the-parameter-name"]], "The scale factor": [[9, "the-scale-factor"]], "The Default column": [[9, "the-default-column"]], "Attributes": [[9, "attributes"]], "Methods": [[9, "methods"]], "Parcel mode": [[4, "parcel-mode"], [11, "parcel-mode"], [7, "parcel-mode"], [8, "parcel-mode"]], "Pixel mode": [[5, "pixel-mode"], [11, "pixel-mode"], [7, "pixel-mode"], [8, "pixel-mode"]], "Returns": [[11, "returns"], [11, "id2"], [11, "id4"], [11, "id6"], [11, "id8"], [11, "id10"], [11, "id12"], [11, "id13"], [11, "id15"], [14, "returns"], [14, "id2"], [7, "returns"], [8, "returns"], [8, "id2"], [8, "id4"], [8, "id6"], [8, "id8"], [8, "id9"], [8, "id11"], [8, "id13"], [8, "id15"], [8, "id17"], [8, "id19"]], "Preparing the weather data cube": [[11, "preparing-the-weather-data-cube"]], "Precipitation": [[11, "precipitation"]], "Reference evapotranspiration": [[11, "reference-evapotranspiration"]], "Information on requested variables": [[11, "information-on-requested-variables"]], "Formatting and preprocessing the raw data": [[11, "formatting-and-preprocessing-the-raw-data"]], "Arguments (packed in args: tuple)": [[11, "arguments-packed-in-args-tuple"], [8, "arguments-packed-in-args-tuple"]], "How the SAMIR functions works": [[14, "how-the-samir-functions-works"]], "Preparing the land cover raster": [[7, "preparing-the-land-cover-raster"]], "Land Cover preprocessing": [[7, "land-cover-preprocessing"]], "Preparing the soil data raster": [[10, "preparing-the-soil-data-raster"]], "Soil data preprocessing": [[10, "soil-data-preprocessing"]], "Preparing the NDVI data cube": [[8, "preparing-the-ndvi-data-cube"]], "Download satellite imagery": [[8, "download-satellite-imagery"]], "Calculate NDVI": [[8, "calculate-ndvi"]], "NDVI calculation": [[8, "ndvi-calculation"]], "NDVI extraction": [[8, "ndvi-extraction"]], "NDVI formatting": [[8, "ndvi-formatting"]], "Choosing the run mode": [[3, "choosing-the-run-mode"]], "Installing the conda environment": [[15, "installing-the-conda-environment"]], "Setting up the correct environnment and parameters": [[17, "setting-up-the-correct-environnment-and-parameters"]], "Project file structure": [[0, "project-file-structure"]], "Understanding the json config file": [[16, "understanding-the-json-config-file"]]}, "indexentries": {}})