How the SAMIR functions works

modspa_pixel.source.modspa_samir.run_samir(json_config_file: str, csv_param_file: str, ndvi_cube_path: str, weather_path: str, soil_params_path: str, land_cover_path: str, save_path: str, additional_outputs: dict | None = None, available_ram: int = 8, dask: bool = False) None[source]
modspa_pixel.source.modspa_samir.samir_daily(NDVI: ndarray, ET0: ndarray, Rain: ndarray, Wfc: ndarray, Wwp: ndarray, params: dict, Dr0: ndarray, Dd0: ndarray, Zr0: ndarray, E0: ndarray, Tr0: ndarray, Dei0: ndarray, Dep0: ndarray, iday: int) Tuple[ndarray][source]

Run the SAMIR model on a single day. Inputs and outputs are numpy.ndarray. Calls functions compiled with numba for intermediary calculations.

Arguments

  1. NDVI: np.ndarray

    input NDVI

  2. ET0: np.ndarray

    input ET0

  3. Rain: np.ndarray

    input Rain

  4. Wfc: np.ndarray

    field capacity

  5. Wwp: np.ndarray

    field wilting point

  6. params: dict

    dictionnary containing the rasterized samir parameters and their scale factors

  7. Dr0: np.ndarray

    previous day root layer depletion

  8. Dd0: np.ndarray

    previous day deep layer depletion

  9. Zr0: np.ndarray

    previous day root depth

  10. E0: np.ndarray previous day surface evaporation

  11. Tr0: np.ndarray previous day plant transpiration

  12. Dei0: np.ndarray previous day surface layer depletion for irrigation part

  13. Dep0: np.ndarray previous day surface layer depletion for precipitation part

  14. iday: int current loop counter

Returns

  1. current_day_outouts: Tuple[np.ndarray]

    multiple numpy.ndarray arrays are returned as a tuple for current day