Documentation is on lisflood-usecases repository, as a README.md file.Source Code
This repository holds a set of NetCDF tools. You will find documentation of each tool as a README file under its dedicated folder on lisflood-utilities repositorySource Code
If you find a bug or a way to improve our code,
in functionalities, accuracy, or efficency, or you simply found that we missed something, you can either open an issue or submit a pull request.
Please follow these guidelines in order to contribute.
Open an issue
Just go on the GitHub repository of interest and open an issue. Have a look at this page to know how to do it: create an issue on GitHub. When opening an issue, please be as more specific as possible. Furthermore, if you are reporting a bug or you are not able to run our software, you should include some information about your environment:
- OS (Linux distro, Windows version...)
- Python and packages versions
- Input data (e.g. specify meteo datasets)
- Settings and configuration files in case you use custom versions
- Any other information that can be useful to debug or evaluate a feature request etc.
Create a pull request
If you want to contribute to the code, you can send us your changes proposals using the standard GitHub flow for open source software:
- Fork the repository you want to contribute to
- Create a dedicated branch on the forked repository
- Apply your changes on that branch and push them to your (forked) repository
- Create a Pull Request from your forked repository and branch to our original repository. Follow this detailed GitHub guide about the topic: create a pull request on GitHub.
Our team will review your code changes and decide, whether your branch will be merged into the master.
Note: Individual user support cannot be provided! We try to keep the open-source repository as up-to-date and informative as possible but we cannot guarantee that we reply to all issues or requests.