Search.setIndex({"docnames": ["index", "inputs/input_preparation", "inputs/land_cover", "inputs/ndvi_cube", "inputs/samir_params", "inputs/soil_data", "inputs/weather_cube", "samir/data_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_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, "modul": 0, "search": 0, "page": 0, "thi": 0, "project": 0, "i": 0, "under": 0, "activ": 0, "develop": 0, "set": 0, "up": 0, "correct": 0, "environn": 0, "paramet": [0, 1, 9], "run": [0, 9], "samir": [0, 1], "model": [0, 9], "prepar": [0, 9], "input": [0, 9], "instal": [0, 12], "conda": [0, 12], "understand": [0, 12], "json": [0, 9, 12], "config": [0, 9, 12], "file": [0, 1, 9, 12], "ndvi": [0, 1, 9], "data": [0, 1], "cube": [0, 1, 9], "weather": [0, 1, 9], "land": [0, 1, 9], "cover": [0, 1, 9], "raster": [0, 1, 9], "soil": [0, 1, 9], "csv": [0, 1, 9], "good": [0, 8], "practic": [0, 8], "us": [0, 8], "how": [0, 8], "function": [0, 8], "work": [0, 8], "an": 0, "adapt": 0, "exist": 0, "http": [], "gitlab": [], "cesbio": [], "omp": [], "eu": [], "modelis": 0, "process": 0, "chain": 0, "It": 0, "mix": 0, "satellit": 0, "optic": 0, "like": 0, "safi": 0, "_onli": [], "current": [0, 9], "supported_": [], "spatial": 0, "The": 0, "previou": [0, 9], "version": 0, "panda": 0, "datafram": 0, "parcel": 0, "scale": [0, 9], "ar": [0, 9], "aggreg": 0, "numpi": [0, 9], "allow": 0, "higher": 0, "resolut": 0, "cost": 0, "increas": 0, "storag": 0, "calcul": [0, 9], "requir": 0, "onli": 0, "support": 0, "modspa_pixel": 9, "code": 9, "modspa_samir": 9, "run_samir": [8, 9], "json_config_fil": 9, "str": 9, "csv_param_fil": 9, "ndvi_cube_path": 9, "weather_path": 9, "soil_params_path": 9, "land_cover_path": 9, "save_path": 9, "additional_output": 9, "dict": 9, "none": 9, "available_ram": 9, "int": 9, "8": 9, "sourc": 9, "call": 9, "samir_daili": [8, 9], "argument": [], "1": [], "path": 9, "output": 9, "save": 9, "default": 9, "dictionnari": 9, "contain": 9, "optionn": 9, "addit": 9, "avail": 9, "ram": 9, "gib": 9, "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": 9, "compil": 9, "numba": 9, "intermediari": 9, "np": 9, "field": 9, "capac": 9, "wilt": 9, "point": 9, "factor": 9, "root": 9, "layer": 9, "deplet": 9, "deep": 9, "depth": 9, "surfac": 9, "evapor": 9, "plant": 9, "transpir": 9, "irrig": 9, "part": 9, "precipit": 9, "loop": 9, "counter": 9, "current_day_outout": 9, "multipl": 9, "arrai": 9}, "objects": {"modspa_pixel.code.modspa_samir": [[9, 0, 1, "", "run_samir"], [9, 0, 1, "", "samir_daily"]]}, "objtypes": {"0": "py:function"}, "objnames": {"0": ["py", "function", "Python function"]}, "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": 9, "return": 9}, "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": {"Contents:": [[1, null], [8, null], [12, null], [0, null]], "Preparing the inputs for Modspa-Pixel": [[1, "preparing-the-inputs-for-modspa-pixel"]], "Preparing the land cover raster": [[2, "preparing-the-land-cover-raster"]], "Preparing the NDVI data cube": [[3, "preparing-the-ndvi-data-cube"]], "Preparing the SAMIR parameter csv file": [[4, "preparing-the-samir-parameter-csv-file"]], "Preparing the soil data raster": [[5, "preparing-the-soil-data-raster"]], "Preparing the weather data cube": [[6, "preparing-the-weather-data-cube"]], "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"]], "Understanding the json config file": [[11, "understanding-the-json-config-file"]], "Setting up the correct environnment and parameters": [[12, "setting-up-the-correct-environnment-and-parameters"]], "ModSpa-Pixel": [[0, "modspa-pixel"]], "Indices and tables": [[0, "indices-and-tables"]], "How the SAMIR functions works": [[9, "how-the-samir-functions-works"]], "Arguments": [[9, "arguments"], [9, "id1"]], "Returns": [[9, "returns"], [9, "id2"]]}, "indexentries": {"run_samir() (in module modspa_pixel.code.modspa_samir)": [[9, "modspa_pixel.code.modspa_samir.run_samir"]], "samir_daily() (in module modspa_pixel.code.modspa_samir)": [[9, "modspa_pixel.code.modspa_samir.samir_daily"]]}})