Shire

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

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. 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

(back to top)

Built With

(back to top)

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.

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.

Installation

After setting up the virtual environment, clone the repository

   git clone https://git-ce.rwth-aachen.de/mbd/shire.git

and then install the prerequisites in requirement.txt

   pip install -r /path/to/requirements.txt

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/github_username/repo_name

(back to top)

Acknowledgments

(back to top)