moja-global / FLINT.Module.Agricultural_Soil_Model

Code repository for FLINT agricultural soils module.
Mozilla Public License 2.0
1 stars 6 forks source link

Update documentation to instruct user to set GDAL path in libs.base_agri.win.json #26

Closed shubhamkarande13 closed 3 years ago

shubhamkarande13 commented 3 years ago

What does the current documentation state? The current documentation does not tell the user to change path of the GDAL library in the libs.base_agri.win.json file to directory where GDAL and FLINT are installed.

Why do you want to improve the statement? Without this change in the config file, FLINT will throw an error saying that GDAL is missing. GDAL is necessary to run the Agricultural Soil module.

Proposed statement In libs.base_agri.win.json file in FLINT.Module.Agricultural_Soil_Model/Run_Env/config/

{
    "Libraries": {
        "moja.modules.gdal": {
            "library": "moja.modules.gdald.dll",
         "path": "C:/Users/sulay/Desktop/moja-global/FLINT/Source/build/bin/Debug",
            "type": "external"
        },

Change "path": "C:/Users/sulay/Desktop/moja-global/FLINT/Source/build/bin/Debug", to the path where FLINT is installed and GDAL is built. For example if FLINT is installed in C:/Development/moja-global/FLINT, then the path for GDAL will be C:/Development/moja-global/FLINT/Source/build/bin/Debug

For example the libs.base_agri.win.json file should look like this :

{
    "Libraries": {
        "moja.modules.gdal": {
            "library": "moja.modules.gdald.dll",
            "path": "C:/Development/moja-global/FLINT/Source/build/bin/Debug",
            "type": "external"
        },
        "moja.flint.example.agri": {
            "library": "moja.flint.example.agrid.dll",
            "path": "%LOCAL_LIBS%",
            "type": "external"
        }
    }
}