diff --git a/README.md b/README.md index ef79c15e5abeb52821815a96e4414fb6ab2be4b6..7641829812d14487eb9fe77bf90461ffe8bc073d 100644 --- a/README.md +++ b/README.md @@ -37,14 +37,14 @@ <!--<h3 align="center">Shire</h3> --> <p align="center"> - <a href="https://git-ce.rwth-aachen.de/mbd/shire.git/docs"><strong>Explore the docs »</strong></a> + <a href="https://git-ce.rwth-aachen.de/mbd/shire/-/docs"><strong>Explore the docs »</strong></a> <br /> <br /> - <a href="https://github.com/github_username/repo_name">View Publication</a> + <a href="https://doi.org/10.21203/rs.3.rs-3254996/v2">View Publication</a> · - <a href="https://github.com/github_username/repo_name/issues">Report Bug</a> + <a href="https://git-ce.rwth-aachen.de/mbd/shire/-/issues">Report Bug</a> · - <a href="https://github.com/github_username/repo_name/issues">Request Feature</a> + <a href="https://git-ce.rwth-aachen.de/mbd/shire/-/issues">Request Feature</a> </p> </div> @@ -75,7 +75,7 @@ <!-- ABOUT THE PROJECT --> ## About Shire -Shire (LandSlide Hazard mappIng framEwork) is intended as a support to streamline landslide susceptibility and hazard mapping using a Random Forest classifier. It provides support for repetitive steps in landslide susceptibility and hazard mapping such as input dataset generation including data pre-processing. +SHIRE (**S**usceptibility **H**azard mapp**I**ng f**R**am**E**work) is a tool to facilitate and streamline landslide susceptibility and hazard mapping using a Random Forest classifier. It provides support for repetitive steps in landslide susceptibility and hazard mapping such as input dataset generation including data pre-processing. It is a Python-based modular framework that can be complemented with individual modules necessary for answer individual mapping challenges due to the open-access nature of the code. Shire was developed as part of the [KISTE Project](https://kiste-project.de/) @@ -102,14 +102,12 @@ Shire was developed as part of the [KISTE Project](https://kiste-project.de/) <!-- GETTING STARTED --> ## Getting Started -Please make sure to set up a virtual environment before installing the prerequisites. This is important as some packages might have dependencies among each other. Furthermore the current version of the workflow still uses numpy.interp2d which has recently been announced to be decapitated. +Please make sure to set up a virtual environment before installing the prerequisites. This is important as some packages might have dependencies among each other. Furthermore, the current version of the framework still uses numpy.interp2d which has recently been announced to be deprecated. The framework was developed using Python 3.7 Then, clone the repository to your local system and you are ready to go. -The master branch contains the version of the framework which contains the user interface. The branch expert_application contains the framework version in which the user manages the settings in a seperate settings-file (settings.py) - ### Prerequisites The framework has been developed and tested on a MacBook Pro using MacOS Monteray 12.7. Testing of the framework on other operating systems is planned. @@ -170,9 +168,10 @@ Distributed under the MIT License. See `LICENSE.txt` for more information. <!-- CONTACT --> ## Contact -If you have questions or comments please feel free to reach out to: - -Ann-Kathrin Edrich - edrich@mbd.rwth-aachen.de +If you have questions or comments please feel free to reach out to:<br> +[Ann-Kathrin Edrich](https://www.mbd.rwth-aachen.de/cms/mbd/der-lehrstuhl/team/~qnekv/ann-kathrin-edrich/?lidx=1) - edrich@mbd.rwth-aachen.de <br> +Methods for model-based Development in Computational Engineering <br> +RWTH Aachen University Project Link: [KISTE Project](https://kiste-project.de/)