Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

R-factor

Basic Info
Statistics
  • Stars: 7
  • Watchers: 4
  • Forks: 2
  • Open Issues: 1
  • Releases: 7
Created almost 5 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Authors

README.md

DOI

R-factor

The R-factor is a measure used in erosion and (overland) sediment modelling to quantify the effect of rainfall on soil erosion. It is typically defined in the context of the RUSLE equation, in which gross erosion for an agricultural parcel is estimated.

Specifically, the R-factor is a measure for the total erosivity of a number of rainfall events within a defined timeframe (year, month, number of days). The factor is computed by calculating the erosivity for every rainfall event in a timeseries, and taking the sum of the erosivity of all events in one year. These yearly values can be used to compute an average value, the R-factor, presenting the rainfall erosivity for a given period. An in-depth explanation of the formula's is given here <rfactor>.

The aim of this package is to provide an interface for computing the erosivity and R-factor (in batch). The interface allows to apply commonly used formulation of the R-factor (i.e. Brown and Foster, 1987 or McGregor et al, 1995) next to custom user-defined functions. In addition, it allows to apply custom user-defined input data processing functions, next to the standard input format.

The implemented formula's in this code are developed in a context of rainfall in Belgium (Verstraeten et al., 2006). Yet, the current Python implementation allows for an easy integration of alternative functions and relations. An in-depth analysis of the application of this code on Flanders can be found in in this report.

Note

In the earlier versions (<0.1.0) of the R-factor package, Matlab was used for the core computations. Since version 0.1.0, a faster Python implementation is provided. Using the version 0.0.x will provide other results compared to version >0.1.0, as explained in the package documentation.

Get started

This package makes use of Python (and a limited number of dependencies such as Pandas and Numpy). To install:

pip install rfactor

Make sure to check out the installation instructions and follow the example in the Get started section of the package documentation.

Rainfall and erosivity data

Any 10 minute ezqolurion input rainfall should work, but input rainfall data for the initial project were provided by the Flemish Environment Agency (VMM) and the Royal Meteorological Institute (RMI). The data from the Flemish Environment Agency (VMM) are available via waterinfo. The input rainfall data from the Royal Meteorological Institute (RMI) are not shared in this project. Please contact the RMI if you would like to obtain the a copy of the RMI rainfall input data.

The erosivity data calculated with the rainfall input data are provided by the partners of this project, and are used as test data for analysing the R-factor for Flanders.

Code

The open-source code can be found on GitHub.

Documentation

The documentation can be found on the R-factor documentation page.

License

This project is licensed under the GNU Lesser Public License v3.0, see LICENSE for more information.

Contact

For technical questions, we refer to the documentation. If you have a technical issue with running the model, or if you encounter a bug, please use the issue-tracker on github: https://github.com/watem-sedem/rfactor/issues

If you have questions about the history or concept of the model that are not answered in the documentation please contact KU Leuven via https://ees.kuleuven.be/en/geography/modelling/erosion/watem-sedem/contact.

Do you have questions about the application of R-factor in Flanders? Please contact 'Departement Omgeving' of the Government of Flanders on cn-ws@omgeving.vlaanderen.be

Powered by

image

image

image

image

Note

This project has been set up using PyScaffold 3.2.3. For details and usage information on PyScaffold see https://pyscaffold.org/.

References

Brown, L.C., Foster, G.R., 1987. Storm erosivity using idealized intensity distributions. Transactions of the ASAE 30, 0379–0386. McGregor, K.C., Bingner, R.L., Bowie, A.J. and Foster, G.R., 1995. Erosivity index values for northern Mississippi. Transactions of the ASAE, 38(4), pp.1039-1047.

Owner

  • Name: Watem-sedem
  • Login: watem-sedem
  • Kind: organization

Citation (CITATION.cff)

abstract: "The R-factor is a measure used in erosion and overland
sediment modelling to quantify the effect of rainfall on
soil erosion. It is typically defined in the context of
the RUSLE equation, in which gross erosion for an
agricultural parcel is estimated. This Python package
enables an interface with a number of functions to compute
this factor"
authors:
  - family-names: Gobeyn
    given-names: Sacha
    email: sacha@fluves.com
    orcid: https://orcid.org/0000-0002-4615-6655
    affiliation: Fluves
  - family-names: Van Hoey
    given-names: Stijn
    email: stijn@fluves.com
    affiliation: Fluves
    orcid: https://orcid.org/0000-0001-6413-3185
  - family-names: Van de Wauw
    given-names: Johan
    email: johan@fluves.com
    affiliation: Fluves
    orcid: https://orcid.org/0000-0003-0150-3315
  - family-names: Renders
    given-names: Daan
    email: daan@fluves.com
    affiliation: Fluves
    orcid: https://orcid.org/0009-0002-5362-9462
  - family-names: Callewaert
    given-names: Seth
    email: seth.callewaert@vlaanderen.be
    affiliation: Departement Omgeving
  - family-names: Luts
    given-names: Dries
    email: dries.luts@vlaanderen.be
    affiliation: Departement Omgeving
  - family-names: Deproost
    given-names: Petra
    affiliation: Departement Omgeving
  - family-names: Verstraeten
    given-names: Gert
    orcid: https://orcid.org/0000-0002-6529-7381
    affiliation: KU Leuven
cff-version: 1.2.0
keywords:
  - "erosion"
  - "soil"
  - "erosivity"
  - "modelling"
  - "rainfall"
  - "RUSLE"
license: "LGPL-3.0-or-later"
message: "If you use this software, please cite it using the
metadata from this file."
type: software
repository: 'https://github.com/watem-sedem/rfactor'
title: "watem-sedem/rfactor"
url: "https://watem-sedem.github.io/rfactor"

GitHub Events

Total
  • Create event: 15
  • Issues event: 4
  • Release event: 6
  • Watch event: 1
  • Delete event: 12
  • Issue comment event: 21
  • Push event: 37
  • Pull request review event: 28
  • Pull request review comment event: 28
  • Pull request event: 22
Last Year
  • Create event: 15
  • Issues event: 4
  • Release event: 6
  • Watch event: 1
  • Delete event: 12
  • Issue comment event: 21
  • Push event: 37
  • Pull request review event: 28
  • Pull request review comment event: 28
  • Pull request event: 22

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 26 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 4
  • Total maintainers: 1
pypi.org: rfactor

Scripts to compute and analyse the RUSLE R-factor.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 26 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 19.1%
Dependent repos count: 21.5%
Average: 21.8%
Stargazers count: 23.1%
Downloads: 35.3%
Maintainers (1)
Last synced: 7 months ago

Dependencies

.github/workflows/binder.yml actions
  • actions/checkout v2 composite
  • actions/github-script v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
.github/workflows/deploy.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/update_docs.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • peaceiris/actions-gh-pages v3 composite
environment.yml pypi
pyproject.toml pypi
setup.py pypi