diff --git a/README.md b/README.md index 3150e383b81e1c4250a4717d9e5c4a224078806d..3145579448b0a1b341f933e012fb9fe72c6643a2 100644 --- a/README.md +++ b/README.md @@ -151,23 +151,49 @@ The initial window (see Fig. 1) see covers the basic information on the resultin - _Import settings_: if during a previous run the settings defined in this window have been entered and saved, this button allows to load the previous settings to save time If in the general settings window the _prediction dataset_ option has been ticked the following window opens: -|  - | GUI when ticking the delete feature or add feature tickbox | GUI when ticking the Generate dataset from scratch | | ---------------------- | ---------------------- | | | | +- _Where is your geospatial data stored?_: Here, the path to the csv file needs to be given which provides information on the geospatial data (see Necessary manual preparations above) +- _Feature names_: the path to the list of features to include in the training dataset generation needs to be specified +- _Where do you want the prediction data to be stored?_: A directory can be chosen in which the prediction dataset will be saved. The dataset is stored as a netCDF4 file with the name "prediction.nc". More information on what the netCDF4 file contains can be found below +- _Information on the area of intrest_: under the four _Bounding box_ input boxes _West_, _East_, _North_ and _South_ the boundaries of the area of interest need to be given in decimal degree. +- _Save the settings for later use_: if ticked, as soon as the _submit_ button is pressed, a window is opened to choose the path to save the settings for later use as a pickle file. It will be saved as "settings_pred.pkl" +- _What do you want to do?_: This setting defines how the prediction dataset is generated. _Generate the prediction dataset from scratch_ assumes that no prediction dataset in the directory given above is available to build upon, _Delete feature_ assumes that there is a prediction dataset from which one or several freatures shall be dropped, _Add feature_ assumes there is a prediction dataset to which one or several features shall be added +- If _Delete feature_ or _Add feature_ has been chosen _Which features do you want to add/delete?_ defines which features to add or delete. If there are several, they should be seperated with a comma. Please don't include spacing! +- If _Delete feature_ or _Add feature_ has been chosen _How would you like to preprocess the datasets?_ defines how the features that have been added in the inbox above. Options are 'no_interpolation', 'cluster' and 'interpolation'. Their meaning is described more closely below. For each of the features to add/delete one preprocessing option can be specified which are comma-separated. Please don't include spacing! +- _Import settings_: if during a previous run the settings defined in this window have been entered and saved, this button allows to load the previous settings to save time +If in the general settings window the _training dataset_ option has been ticked the following window opens: | GUI when ticking the delete feature or add feature tickbox | GUI when ticking the Generate dataset from scratch | | ---------------------- | ---------------------- | | | | + +- _Where is your landslide data stored_: The path to the landslide inventory needs to be given here - _Where is your geospatial data stored?_: Here, the path to the csv file needs to be given which provides information on the geospatial data (see Necessary manual preparations above) - _Feature names_: the path to the list of features to include in the training dataset generation needs to be specified -- _Where do you want the prediction data to be stored?_: A directory can be chosen in which the prediction dataset will be saved. The dataset is stored as a netCDF4 file with the name "prediction.nc". More information on what the netCDF4 file contains can be found below -- _Information on the area of intrest_: under the four _Bounding box_ input boxes _West_, _East_, _North_ and _South_ the boundaries of the area of interest need to be given in decimal degree. -- _Save the settings for later use_: if ticked, as soon as the _submit_ button is pressed, a window is opened to choose the path to save the settings for later use as a pickle file. It will be saved as "settings_pred.pkl" -- _What do you want to do?_ +- _Where are your absence locations stored?_: The path to the absence locations needs to be given. For more information see necessary manual preparations +- _Where do you want your training data to be stored?_: Choose a directory to store the training dataset. The file is stored in csv format and is called 'training.csv'. More information on the resulting file can be found below. +- _Import settings_: if during a previous run the settings defined in this window have been entered and saved, this button allows to load the previous settings to save time +-_Information on the landslide data_: To allow for individual landslide and absence locations inventories information on naming conventions need to be provided here. _x coordinates_ and _y coordinates_ require the labels in the landslide inventory and the absence locations inventory respectively for the x and y coordinates. _Landslide ID_ requires the label for the landslide ID. +- _Number of absence locations_: This defines the number of absence locations included in the training dataset. Please follow the recommendations in the Necessary manual preparations section +- _Save the settings for later use_: if ticked, as soon as the _submit_ button is pressed, a window is opened to choose the path to save the settings for later use as a pickle file. It will be saved as "settings_train.pkl" +- _What do you want to do?_: This setting defines how the training dataset is generated. _Generate the training dataset from scratch_ assumes that no training dataset in the directory given above is available to build upon, _Delete feature_ assumes that there is a training dataset from which one or several freatures shall be dropped, _Add feature_ assumes there is a training dataset to which one or several features shall be added +- If _Generate training dataset from scratch_ is chosen, _How shall the training dataset be compiled?_ can be determined. The options are 'Clustering', 'Interpolation' and 'No interpolation'. More information can be found below +- If _Delete feature_ or _Add feature_ has been chosen _Which features do you want to add/delete?_ defines which features to add or delete. If there are several, they should be seperated with a comma. Please don't include spacing! +- If _Delete feature_ or _Add feature_ has been chosen _How would you like to preprocess the datasets?_ defines how the features that have been added in the inbox above. Options are 'no_interpolation', 'cluster' and 'interpolation'. Their meaning is described more closely below. For each of the features to add/delete one preprocessing option can be specified which are comma-separated. Please don't include spacing! +- _Import settings_: if during a previous run the settings defined in this window have been entered and saved, this button allows to load the previous settings to save time +If in the general settings window the _Map generation_ option has been ticked the following window opens: +Fig.4: GUI for defining the settings for the map generation +- _Path to training dataset_: The path to the existing training dataset needs to be provided +- _Path to prediction dataset_: The path to the existing prediction dataset needs to be provided +- _Where do you want the model to be stored?_: The path needs to be provided where the model shall be stored +- _Features to drop - training_ and _Features to drop - prediction_: If applicable list features that are included in the training or prediction dataset respectively that shall not be considered during training and prediction. If several features shall be dropped, seperate them with a comma. Please don't use spacing after the comma! +- _Model to save_ and _Model to load_: Name of the folder in which the model shall be stored. It should not be generic so that specific models can be imported at a later point in time again. If training and mapping is conducted in one go, both parameters are typically the same. +- _Save above settings for later use_: if ticked, as soon as the _submit_ button is pressed, a window is opened to choose the path to save the settings for later use as a pickle file. It will be saved as "settings_map.pkl" +- _What do you want to do?_: _Model training_ and _Mapping_ can be conducted in one go by ticking both boxes but can also performed independently. <!-- ROADMAP --> ## Roadmap