Newer
Older
Search.setIndex({"docnames": ["file_structure", "filetree", "index", "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", "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", "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, 1, 2, 5], "modul": [2, 5, 8, 13], "search": 2, "page": [2, 14], "thi": [2, 3, 4, 5, 6, 8, 12, 13, 14], "project": [2, 3, 4, 8, 12, 14], "i": [0, 2, 3, 4, 5, 6, 8, 12, 13, 14], "under": [2, 13], "activ": [2, 5, 8, 12], "develop": [2, 3, 4, 7, 14], "set": [2, 6, 13], "up": [2, 5, 13], "correct": [2, 3, 5, 8, 12, 13], "environn": 2, "paramet": [0, 1, 2, 3, 4, 5, 7, 11, 12, 13], "run": [2, 3, 4, 5, 8, 11, 12, 13, 14], "samir": [0, 1, 2, 3, 8, 13], "model": [2, 3, 4, 6, 8, 11, 13], "prepar": 2, "input": [2, 4, 5, 7, 8, 11, 12, 13], "instal": [2, 14], "conda": [2, 14], "understand": [2, 14], "json": [0, 1, 2, 5, 6, 8, 14], "config": [0, 1, 2, 5, 14], "file": [2, 3, 4, 5, 7, 8, 12, 14], "ndvi": [0, 1, 2, 3, 4, 8, 11, 13], "data": [2, 3, 4, 6, 13], "cube": [2, 3, 13], "weather": [2, 3, 4, 5, 13], "land": [2, 3, 6, 7, 8, 13], "cover": [2, 3, 5, 6, 7, 13], "raster": [2, 3, 6, 11], "soil": [2, 3, 13], "csv": [0, 1, 2, 3, 5], "good": [2, 5, 10], "practic": [2, 10], "us": [2, 3, 4, 5, 6, 7, 8, 10, 12, 13], "how": [2, 6, 10, 13], "function": [2, 4, 5, 6, 7, 8, 10], "work": [2, 4, 10, 14], "an": [0, 2, 3, 4, 5, 6, 8, 13], "adapt": 2, "exist": [2, 5, 7], "http": [12, 14], "gitlab": 14, "cesbio": 14, "omp": 14, "eu": 14, "modelis": 2, "process": [2, 3, 5, 8, 13], "chain": [2, 3, 5, 8, 13], "It": [2, 5, 6, 8], "mix": 2, "satellit": [2, 13], "optic": [2, 3, 13], "like": [2, 4, 14], "safi": [2, 3, 8], "_onli": [], "current": [0, 2, 3, 4, 5, 11, 13, 14], "supported_": [], "spatial": [2, 3, 6, 8, 13], "The": [2, 3, 4, 5, 7, 8, 12, 13], "previou": [2, 5, 11], "version": [2, 5, 12, 13, 14], "panda": [2, 3, 6], "datafram": [2, 3, 6], "parcel": [2, 3, 5, 8, 13], "scale": [2, 5, 6, 11], "ar": [2, 3, 5, 6, 8, 11, 13], "aggreg": 2, "numpi": [2, 8, 11], "allow": [2, 5, 6, 8, 13], "higher": [2, 8, 13], "resolut": [2, 5, 8], "cost": 2, "increas": 2, "storag": 2, "calcul": [2, 6, 8, 11, 13], "requir": [2, 3, 5, 8], "onli": [2, 5, 7, 8], "support": [2, 5, 13], "modspa_pixel": [4, 5, 6, 8, 11, 12, 13, 14], "code": [5, 13], "modspa_samir": [0, 1, 11], "run_samir": [0, 1, 10, 11], "json_config_fil": [0, 1, 11], "str": [5, 6, 8, 11, 13], "csv_param_fil": 11, "ndvi_cube_path": [5, 11], "weather_path": 11, "soil_params_path": 11, "land_cover_path": 11, "save_path": [5, 8, 11], "additional_output": 11, "dict": [5, 11], "none": [5, 6, 8, 11], "available_ram": [8, 11], "int": [5, 8, 11, 13], "8": [8, 11, 12], "sourc": [0, 1, 5, 6, 8, 11], "call": [5, 8, 11], "samir_daili": [10, 11], "argument": [], "1": [5, 6, 8], "path": [5, 6, 8, 13], "output": [4, 8, 11, 13], "save": [4, 5, 7, 8, 13], "default": [5, 6, 8, 12], "dictionnari": [5, 11], "contain": [5, 6, 7, 8, 11], "optionn": [], "addit": 4, "avail": 8, "ram": [5, 8, 13], "gib": [8, 13], "return": [], "ndarrai": [8, 11], "et0": [8, 11], "rain": [8, 11], "wfc": [7, 11], "wwp": 11, "param": 11, "dr0": 11, "dd0": 11, "zr0": 11, "e0": 11, "tr0": 11, "dei0": 11, "dep0": 11, "idai": 11, "tupl": 11, "singl": [7, 8, 11], "dai": [5, 8, 11], "compil": 11, "numba": 11, "intermediari": 11, "np": [8, 11], "field": [7, 11], "capac": [7, 11], "wilt": [7, 11], "point": [7, 11], "factor": [6, 11], "root": [11, 12], "layer": 11, "deplet": 11, "deep": 11, "depth": 11, "surfac": [5, 8, 11], "evapor": [8, 11], "plant": 11, "transpir": 11, "irrig": 11, "part": [4, 5, 11, 13], "precipit": 11, "loop": 11, "counter": 11, "current_day_outout": 11, "multipl": [6, 11], "arrai": [8, 11], "frac": 5, "nir": 5, "red": 5, "samir_paramet": 6, "class": [4, 6], "params_samir_class": [0, 1, 6], "paramfil": 6, "load": 6, "all": [3, 5, 6, 8, 12, 13], "one": [4, 5, 6, 8, 12], "object": 6, "ha": [3, 4, 5, 8, 13], "attribut": 8, "tabl": 6, "paramt": [6, 13], "row": 6, "column": 6, "also": [5, 6, 7, 8, 13], "scale_factor": 6, "first": [3, 5, 6, 8], "convert": [5, 6, 7, 8], "integ": [4, 5, 6], "valu": [3, 4, 5, 6, 7, 8, 12], "reduc": 6, "memori": [6, 8, 13], "usag": 6, "second": 6, "fill": 6, "miss": [6, 12], "exampl": [4, 5, 6, 12, 13], "class1": 6, "class2": 6, "class3": 6, "classnam": 6, "classnumb": 6, "0": [5, 6, 8, 12, 13], "00": 6, "2": [4, 5, 6, 8, 13], "000": 6, "3": 6, "fminndvi": 6, "1000": 6, "20": [5, 6], "100": [5, 6], "fmaxndvi": 6, "90": 6, "900": 6, "fminfc": 6, "fmaxfc": 6, "fslope": 6, "40": 6, "50": 6, "500": [5, 6], "foffset": 6, "10": [5, 6, 8], "plateau": 6, "70": [6, 8], "kminndvi": 6, "kmaxndvi": 6, "kminkcb": 6, "kmaxkcb": 6, "98": 6, "kslope": 6, "60": 6, "600": 6, "koffset": 6, "zsoil": 6, "2000": 6, "1600": 6, "1550": 6, "kcmax": 6, "15": 6, "fc_stop": 6, "start_date_irr": 6, "p_trigger": 6, "help": [12, 14], "modspa": [8, 13, 14], "pixel": [5, 8, 13, 14], "script": [3, 4, 5, 14], "section": [3, 13, 14], "you": [4, 5, 6, 7, 12, 13, 14], "To": [5, 12, 14], "begin": [5, 14], "clone": 14, "from": [5, 6, 8, 14], "github": 14, "follow": [5, 6, 7, 8, 12, 14], "command": [4, 8, 12, 14], "should": [4, 6, 7, 12, 14], "creat": [4, 5, 6, 8, 12, 13, 14], "directori": [5, 12, 13, 14], "your": [4, 5, 8, 12, 13, 14], "A": [12, 13, 14], "graphic": [13, 14], "interfac": [13, 14], "modifi": [13, 14], "configur": [6, 8, 13, 14], "plan": [13, 14], "later": [4, 5, 13, 14], "cd": [], "directory_where_modspa_project_will_be_loc": [], "git": 14, "auclairj": [13, 14], "thz": 14, "have": [3, 4, 6, 7, 8, 12, 13, 14], "been": 14, "test": [0, 1, 13, 14], "linux": 14, "ubuntu": 14, "oper": [8, 13, 14], "system": 14, "some": [5, 8, 12, 13, 14], "tool": 14, "packag": [12, 14], "might": [5, 12, 14], "other": [4, 6, 7, 8, 14], "window": [3, 5, 8, 13, 14], "mac": 14, "o": 14, "If": [6, 7, 12], "yet": 12, "machin": [5, 12, 13], "start": [4, 8, 12, 13], "step": [5, 12], "link": 12, "yaml": 12, "includ": [4, 12], "automat": [4, 5, 8, 12], "virtual": 12, "librari": 12, "depend": [5, 12, 13], "copi": [], "base": [12, 14], "env": 12, "f": 12, "modspa_pixel_env": [0, 1, 12], "That": 12, "": [5, 8, 12], "otb": [4, 7, 8, 12], "properli": 12, "check": 12, "its": 12, "otbcli_readimageinfo": 12, "error": 12, "wait": 12, "least": 12, "readimageinfo": 12, "applic": [8, 12], "get": [3, 12], "inform": [4, 12], "about": [5, 12], "imag": [4, 5, 8, 12, 13], "complet": [8, 12, 13], "document": [4, 12], "www": 12, "orfeo": 12, "toolbox": 12, "org": 12, "cookbook": 12, "app_readimageinfo": 12, "html": 12, "string": [5, 12], "mandatori": 12, "imagemetadata": 12, "boolean": [5, 12], "displai": 12, "metadata": 12, "fals": [5, 11, 12, 13], "outgeom": 12, "write": [5, 12], "geom": 12, "option": [12, 13], "off": 12, "rgb": 12, "group": 12, "progress": [4, 7, 12], "report": 12, "list": [5, 8, 12], "long": [3, 12, 13], "empti": [6, 12], "given": [5, 12], "kei": 12, "param1": 12, "paramn": 12, "see": 12, "detail": [3, 12, 13], "those": [5, 8, 12], "qb_toulouse_ortho_x": 12, "tif": [4, 5, 8, 12], "free": [5, 12], "invalid": 12, "pointer": 12, "abort": 12, "receiv": 12, "found": [4, 5, 12], "refer": [4, 12], "link_to_conda_instal": [], "_": [], "random": 12, "link_to_otb_instal": [], "global": [3, 13], "locat": [5, 6, 13], "config_modspa": [0, 1, 13], "_comment": 13, "sart": 13, "date": [3, 5, 8, 13], "period": [8, 13], "which": [4, 5, 8, 13], "start_dat": [5, 8, 13], "2020": 13, "01": 13, "_comment1": [], "end": [5, 8, 13], "end_dat": [5, 8, 13], "12": [8, 13], "31": 13, "_comment2": [], "shapefil": [4, 5, 8, 13], "path_to_config_fil": [], "home": 13, "eodag": [5, 13], "yml": [0, 1, 13], "_comment3": [], "shapefile_path": 13, "mnt": 13, "e": [4, 13], "scihub": 13, "boundari": 13, "shp": [5, 13], "_comment4": [], "download": [3, 8, 13], "download_path": [5, 13], "_comment5": [], "netcdf": [8, 13], "era5": [8, 13], "era5_path": 13, "_comment9": [], "name": [4, 6, 7, 8, 13], "subdirectori": 13, "log": 13, "run_nam": 13, "_comment10": [], "prefer": 13, "s2": 13, "provid": [5, 13], "choic": 13, "theia": [5, 13], "copernicu": [5, 13], "preferred_provid": [5, 13], "_comment13": [], "overwrit": 13, "true": [8, 13], "want": [4, 13], "rewrit": 13, "take": [5, 6, 8, 13], "longer": 13, "ndvi_overwrit": 13, "_comment14": [], "maximum": [5, 13], "cloud": 13, "percentag": [5, 13], "cloud_cover_limit": [5, 13], "80": [5, 13], "_comment20": [], "max": [8, 13], "number": [4, 8, 13], "processor": [8, 13], "core": [8, 13], "multiprocess": 13, "max_cpu": 13, "choos": [2, 5, 8, 13], "where": [4, 5, 13], "differ": [5, 6, 13], "path_to_shapefil": [], "notebook": [], "sigpac_noguera_2020_id_grup": [], "sentinel": [4, 5, 8, 13], "path_to_eodag_config_fil": 13, "4": [5, 6, 13], "amount": 13, "max_ram": [8, 13], "16": 13, "deokfoef": [], "dzofzoff": [], "fzojozgg": [], "simul": [6, 13], "yyyi": [5, 8, 13], "mm": [5, 8, 13], "dd": [5, 8, 13], "format": [5, 13], "open": [5, 8, 13], "defin": [5, 13], "mode": [2, 3, 5, 8, 13], "delimit": 13, "need": [5, 8, 13], "raw": [3, 13], "each": [3, 4, 6, 7, 8, 13], "type": [4, 5, 6, 13], "imageri": [3, 13], "For": [3, 4, 5, 6, 13], "larg": [3, 8, 13], "over": [3, 5, 8, 13], "time": [3, 5, 8, 13], "make": [3, 13], "sure": [3, 13], "enough": [3, 13], "disk": [3, 5, 13], "space": [3, 5, 13], "preprocess": [0, 1, 3, 5, 13], "carri": 13, "between": [2, 4, 5, 8, 13], "atmospher": 13, "two": [5, 7, 8, 13], "bool": [5, 8, 11, 13], "don": 13, "t": [5, 13], "can": [2, 4, 5, 6, 7, 8, 13], "hour": [5, 13], "more": [5, 13], "filter": [5, 13], "out": [4, 13], "than": [5, 8, 13], "certain": 13, "These": 13, "faster": 13, "bewar": 13, "overload": 13, "wise": 13, "when": 13, "high": [5, 13], "perform": 13, "cluster": 13, "alloc": 13, "veri": [5, 8, 13], "hungri": [5, 13], "lot": 3, "same": [3, 4, 7, 8], "grid": [3, 4, 7, 8], "result": [3, 5, 7], "etc": 3, "normal": 5, "veget": 5, "commonli": 5, "estim": [5, 8], "chang": [5, 6], "through": 5, "doe": 5, "correspond": [5, 6], "physic": 5, "quantiti": 5, "proxi": 5, "biomass": 5, "fact": 5, "low": [5, 8], "reflect": 5, "band": 5, "photosynthet": 5, "radiat": [5, 8], "infrar": 5, "unus": 5, "sun": 5, "light": 5, "spectrum": 5, "usuali": [], "neg": 5, "water": [5, 8], "bodi": 5, "posit": 5, "highli": 5, "area": [5, 8], "around": 5, "miner": 5, "human": 5, "made": 5, "In": 5, "corr_": 5, "acorvi": 5, "math": [], "appli": 5, "smooth": 5, "extrem": 5, "download_s2": [0, 1, 5], "download_s2_data": 5, "look": 5, "product": 5, "dure": 5, "specif": 5, "whole": 5, "envelopp": 5, "sever": 5, "tile": 5, "chosen": [4, 5], "pass": 5, "befor": 5, "product_path": 5, "specifi": 5, "zip": 5, "tar": 5, "archiv": 5, "extract": [3, 4, 5, 8], "extract_zip_arch": 5, "list_path": 5, "bands_to_extract": 5, "remove_arch": 5, "usual": [5, 8], "match": 5, "b3": 5, "b4": 5, "_b3": 5, "_b4": 5, "architectur": 5, "whether": 5, "remov": [5, 8], "product_list": 5, "delet": 5, "landsat": 5, "ad": 5, "soon": 5, "calculate_ndvi": [0, 1, 5], "extracted_path": 5, "save_dir": 5, "boundary_shapefile_path": 5, "chunk_siz": 5, "x": 5, "4096": 5, "y": 5, "acorvi_corr": 5, "xarrai": 5, "dataset": [3, 4, 5, 7, 8], "uint8": 5, "255": 5, "union": 5, "pre": 5, "geograph": 5, "bound": [5, 8], "meter": [5, 8], "chunk": 5, "size": 5, "dask": [5, 11], "add": 5, "adjust": 5, "interpolate_ndvi": 5, "ndvi_path": [5, 8], "config_fil": [5, 8], "512": 5, "interpol": [4, 5], "daili": [5, 8], "frequenc": 5, "desir": 5, "mean": 5, "dimens": 5, "divid": 5, "along": 5, "axi": 5, "done": [4, 5, 8], "easi": 5, "parallel": 5, "integr": 5, "them": 5, "stack": 5, "dimension": 5, "pre_cub": 5, "netcdf4": [5, 7, 8], "nc": [0, 1, 5, 8], "effici": [5, 8], "read": 5, "limit": 5, "byte": 5, "per": [5, 8], "give": 5, "precis": 5, "lower": 5, "uncertainti": 5, "measur": [5, 8], "littl": 5, "actual": [5, 8], "lost": 5, "onc": [4, 5], "written": [5, 6], "rare": 5, "revisit": 5, "smaller": 5, "5": [5, 6, 8], "final": 5, "both": [5, 7], "ressourc": 5, "cpu": [5, 8], "evapotranspir": [], "variou": 8, "variabl": 7, "structur": [2, 3, 8], "georeferenc": 8, "produc": 8, "necessari": 8, "As": [7, 8], "now": 8, "era": 8, "implement": 8, "world": 8, "simpl": 8, "python": 8, "api": 8, "download_era5_weath": [0, 1, 8], "request_er5_weath": 8, "raw_s2_image_ref": 8, "reanalysi": 8, "concaten": 8, "obtain": 8, "geotiff": [4, 8], "multiband": [], "unmodifi": 8, "reproject": [4, 7, 8], "precip_fil": [], "et0_fil": [], "No": 8, "special": 8, "crop": 8, "hypothet": 8, "grass": 8, "assum": 8, "height": 8, "m": 8, "fix": 8, "resist": 8, "albedo": 8, "23": 8, "close": 8, "resembl": 8, "extens": 8, "green": 8, "well": 8, "uniform": [7, 8], "grow": 8, "shade": 8, "ground": 8, "eto": 8, "2m_temperatur": 8, "air": 8, "temperatur": 8, "abov": 8, "2m_dewpoint_temperatur": 8, "dewpoint": 8, "surface_solar_radiation_downward": 8, "total": 8, "downward": 8, "solar": 8, "total_precipit": 8, "10m_u_component_of_wind": 8, "north": 8, "south": 8, "wind": 8, "speed": 8, "10m_v_component_of_wind": 8, "east": 8, "west": 8, "main": 8, "sub": 8, "month": 8, "lib_era5_land_pixel": [0, 1, 8], "call_era5land_daily_for_modspa": 8, "float": [4, 8], "output_path": 8, "9": 8, "calculu": 8, "forc": 8, "reanalysis_era5": 8, "surface_net_solar_radi": 8, "surface_pressur": 8, "mean_sea_level_pressur": 8, "potential_evapor": 8, "total_evapor": 8, "snowfal": 8, "box": 8, "demand": 8, "lat_max": 8, "lon_min": 8, "lat_min": 8, "lon_max": 8, "logic": 8, "server": 8, "wg": 8, "84": 8, "lattitud": 8, "longitud": 8, "convers": 8, "et_0": 8, "much": 8, "order": 8, "clip": [4, 8], "superimpos": [4, 8], "advantag": 8, "being": 8, "howev": [2, 8], "handl": 8, "otbcli_superimpos": [4, 8], "era5land_daily_to_yearly_nc": [], "list_era5land_fil": 8, "output_fil": 8, "h": 8, "select": 8, "without": 8, "right": 8, "coordin": 8, "subprocess": 8, "spawn": 8, "receiviv": 8, "half": 8, "temporari": 8, "output_file_rain": [], "output_file_et0": [], "calculate_et0_pixel": 8, "pixel_dataset": 8, "lat": 8, "lon": 8, "year": 8, "xr": 8, "latitudin": 8, "longitudin": 8, "et0_valu": 8, "And": 8, "combine_weather2netcdf": 8, "rain_fil": 8, "et0_til": 8, "weather_fil": 8, "dl_s2": [0, 1], "__init__": [0, 1, 6], "py": [0, 1], "csv_file": [0, 1], "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": [0, 1], "dev_samir_xarrai": [0, 1], "ipynb": [0, 1], "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], "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, 3, 4, 6], "makefil": [0, 1], "code_toolbox": [0, 1], "tree": [], "here": [0, 4, 6], "outlai": 0, "strucutr": 0, "pd": 6, "manual": 4, "user": [2, 4], "There": 4, "gener": [4, 7], "definit": 4, "identif": 4, "artifici": 4, "find": 4, "repres": 4, "valid": 4, "do": 4, "inr": 4, "reference_satellite_imag": 4, "inm": 4, "lc_raster_input": 4, "lc_raster_output": 4, "nn": 4, "g": 4, "stand": 4, "nearest": 4, "neighbor": 4, "thei": 4, "new": 4, "wwc": 7, "scalar": 7, "organis": 6, "class4": 6, "class5": 6, "class6": 6, "class7": 6, "6": 6, "7": 6, "075": 6, "kcb_max": 6, "24": 6, "ze": 6, "300": 6, "init_ru": 6, "87": 6, "diff": 6, "diffr": 6, "rew": 6, "minzr": 6, "150": 6, "maxzr": 6, "p": 6, "55": 6, "fw": 6, "irrig_auto": 6, "irrig_man": 6, "kcb_stop_irrig": 6, "header": 6, "three": 6, "leftmost": 6, "manag": 6, "cell": 6, "built": 3, "averag": 3, "imput": 3, "parcel_to_pixel": [0, 1], "postprocess": [0, 1], "request": [], "raw_ndvi": [0, 1], "filtered_ndvi": [0, 1], "extracted_s2": [0, 1], "interp_ndvi": [0, 1], "ndvi_s2": [0, 1], "extract_ndvi": [0, 1], "still": 2, "era5land_daily_to_yearly_pixel": 8, "output_file_fin": 8}, "objects": {"modspa_pixel.parameters.params_samir_class": [[6, 0, 1, "", "samir_parameters"]], "modspa_pixel.parameters.params_samir_class.samir_parameters": [[6, 1, 1, "", "__init__"]], "modspa_pixel.preprocessing.calculate_ndvi": [[5, 2, 1, "", "calculate_ndvi"], [5, 2, 1, "", "interpolate_ndvi"]], "modspa_pixel.preprocessing.download_ERA5_weather": [[8, 2, 1, "", "request_ER5_weather"]], "modspa_pixel.preprocessing.download_S2": [[5, 2, 1, "", "download_S2_data"], [5, 2, 1, "", "extract_zip_archives"]], "modspa_pixel.preprocessing.lib_era5_land_pixel": [[8, 2, 1, "", "calculate_ET0_pixel"], [8, 2, 1, "", "call_era5land_daily_for_MODSPA"], [8, 2, 1, "", "combine_weather2netcdf"], [8, 2, 1, "", "era5Land_daily_to_yearly_pixel"]], "modspa_pixel.source.modspa_samir": [[11, 2, 1, "", "run_samir"], [11, 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, 3], "pixel": [2, 3, 4], "": [], "document": [], "indic": 2, "tabl": 2, "content": [2, 3, 10, 14], "run": 10, "samir": [6, 9, 10, 11], "model": [9, 10], "set": 14, "up": 14, "correct": 14, "environn": [12, 14], "paramet": [6, 14], "prepar": [3, 4, 5, 6, 7, 8], "input": 3, "instal": 12, "conda": 12, "understand": 13, "json": 13, "config": 13, "file": [0, 6, 13], "land": 4, "cover": 4, "raster": [4, 7], "ndvi": 5, "data": [5, 7, 8], "cube": [5, 8], "csv": 6, "soil": 7, "weather": 8, "good": 9, "practic": 9, "us": 9, "how": 11, "function": 11, "work": 11, "argument": [5, 6, 8, 11], "return": [5, 8, 11], "download": 5, "satellit": 5, "imageri": 5, "calcul": 5, "precipit": 8, "refer": 8, "evapotranspir": 8, "inform": 8, "request": 8, "variabl": 8, "format": 8, "preprocess": 8, "raw": 8, "project": 0, "structur": 0, "tree": [], "attribut": 6, "method": 6, "parcel": 4, "mode": 4}, "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": [[9, "good-practices-to-use-the-samir-model"]], "Run the SAMIR model": [[10, "run-the-samir-model"]], "Contents:": [[10, null], [14, null], [2, null], [3, null]], "Setting up the correct environnment and parameters": [[14, "setting-up-the-correct-environnment-and-parameters"]], "Installing the conda environnment": [[12, "installing-the-conda-environnment"]], "Understanding the json config file": [[13, "understanding-the-json-config-file"]], "Arguments": [[11, "arguments"], [5, "arguments"], [5, "id1"], [5, "id3"], [5, "id5"], [6, "arguments"], [8, "arguments"], [8, "id1"], [8, "id3"], [8, "id5"], [8, "id7"]], "Returns": [[11, "returns"], [5, "returns"], [5, "id2"], [5, "id4"], [5, "id6"], [8, "returns"], [8, "id2"], [8, "id4"], [8, "id6"], [8, "id8"]], "How the SAMIR functions works": [[11, "how-the-samir-functions-works"]], "ModSpa-Pixel": [[2, "modspa-pixel"]], "Indices and tables": [[2, "indices-and-tables"]], "Preparing the inputs for Modspa-Pixel": [[3, "preparing-the-inputs-for-modspa-pixel"]], "Preparing the land cover raster": [[4, "preparing-the-land-cover-raster"]], "Parcel mode": [[4, "parcel-mode"]], "Pixel mode": [[4, "pixel-mode"]], "Preparing the NDVI data cube": [[5, "preparing-the-ndvi-data-cube"]], "Download satellite imagery": [[5, "download-satellite-imagery"]], "Calculate NDVI": [[5, "calculate-ndvi"]], "Preparing the SAMIR parameter csv file": [[6, "preparing-the-samir-parameter-csv-file"]], "Attributes": [[6, "attributes"]], "Methods": [[6, "methods"]], "Preparing the soil data raster": [[7, "preparing-the-soil-data-raster"]], "Preparing the weather data cube": [[8, "preparing-the-weather-data-cube"]], "Precipitation": [[8, "precipitation"]], "Reference evapotranspiration": [[8, "reference-evapotranspiration"]], "Information on requested variables": [[8, "information-on-requested-variables"]], "Formatting and preprocessing the raw data": [[8, "formatting-and-preprocessing-the-raw-data"]], "Project file structure": [[0, "project-file-structure"]]}, "indexentries": {}})