floodsimilarity - a python module to compute the similarity between multiple flood events

Cite as:

Lüdtke, Stefan; Eggert, Daniel; Wendi, Dadiyorto; Schröter, Kai (2022): floodsimilarity - a python module to compute the similarity between multiple flood events. GFZ Data Services. https://doi.org/10.5880/GFZ.4.4.2022.001

Status

I N R E V I E W : Lüdtke, Stefan; Eggert, Daniel; Wendi, Dadiyorto; Schröter, Kai (2022): floodsimilarity - a python module to compute the similarity between multiple flood events. GFZ Data Services. https://doi.org/10.5880/GFZ.4.4.2022.001

Abstract

floodsimilarity provides classes and methods to conduct a similarity analysis between multiple flood events. The library mainly consists of two parts:
(1) algorithms to compute indices and other statistics based on pandas and xarray
(2) well-defined data structures for data exchange (e.g. through the Similarity Backend Module)

floodsimilarity is used by the Digital Earth Similarity Backend Module (Eggert, 2021) as part of the Digital Earth Flood Event Explorer. It is developed at the GFZ German Research Centre for Geosciences and funded by the Initiative and Networking Fund of the Helmholtz Association through the Digital Earth project.

Technical Information

Copyright © 2022 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences,
Potsdam, Germany

Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Authors

Lüdtke, Stefan;GFZ German Research Centre for Geosciences
Eggert, Daniel;GFZ German Research Centre for Geosciences
Wendi, Dadiyorto;GFZ German Research Centre for Geosciences
Schröter, Kai;GFZ German Research Centre for Geosciences

Contact

Lüdtke, Stefan; GFZ German Research Centre for Geosciences;

Keywords

Digital Earth, Flood, Flood Event Explorer

GCMD Science Keywords

More Metadata

datacite: / download xml
- resource (xsi:schemaLocation=http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4.3/metadata.xsd)
  - identifier (identifierType=DOI): 10.5880/GFZ.4.4.2022.001
  - creators
    - creator
      - creatorName (nameType=Personal): Lüdtke, Stefan
      - givenName: Stefan
      - familyName: Lüdtke
      - nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-7888-9175
      - affiliation: GFZ German Research Centre for Geosciences
    - creator
      - creatorName (nameType=Personal): Eggert, Daniel
      - givenName: Daniel
      - familyName: Eggert
      - nameIdentifier (nameIdentifierScheme=ORCID): 0000-0003-0251-4390
      - affiliation: GFZ German Research Centre for Geosciences
    - creator
      - creatorName (nameType=Personal): Wendi, Dadiyorto
      - givenName: Dadiyorto
      - familyName: Wendi
      - nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-9789-579X
      - affiliation: GFZ German Research Centre for Geosciences
    - creator
      - creatorName (nameType=Personal): Schröter, Kai
      - givenName: Kai
      - familyName: Schröter
      - nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-3173-7019
      - affiliation: GFZ German Research Centre for Geosciences
  - titles
    - title: floodsimilarity - a python module to compute the similarity between multiple flood events
  - publisher: GFZ Data Services
  - publicationYear: 2022
  - subjects
    - subject: Digital Earth
    - subject: Flood
    - subject: Flood Event Explorer
    - subject (subjectScheme=NASA/GCMD Earth Science Keywords): EARTH SCIENCE > TERRESTRIAL HYDROSPHERE > SURFACE WATER > FLOODS
    - subject (subjectScheme=NASA/GCMD Earth Science Keywords): EARTH SCIENCE > TERRESTRIAL HYDROSPHERE > SURFACE WATER > RUNOFF
    - subject (subjectScheme=NASA/GCMD Earth Science Keywords): EARTH SCIENCE SERVICES > DATA ANALYSIS AND VISUALIZATION
  - contributors
    - contributor (contributorType=ProjectMember)
      - contributorName (nameType=Personal): Lüdtke, Stefan
      - givenName: Stefan
      - familyName: Lüdtke
      - nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-7888-9175
      - affiliation: GFZ German Research Centre for Geosciences
    - contributor (contributorType=ProjectMember)
      - contributorName (nameType=Personal): Eggert, Daniel
      - givenName: Daniel
      - familyName: Eggert
      - nameIdentifier (nameIdentifierScheme=ORCID): 0000-0003-0251-4390
      - affiliation: GFZ German Research Centre for Geosciences
    - contributor (contributorType=ProjectMember)
      - contributorName (nameType=Personal): Wendi, Dadiyorto
      - givenName: Dadiyorto
      - familyName: Wendi
      - nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-9789-579X
      - affiliation: GFZ German Research Centre for Geosciences
    - contributor (contributorType=ProjectMember)
      - contributorName (nameType=Personal): Schröter, Kai
      - givenName: Kai
      - familyName: Schröter
      - nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-3173-7019
      - affiliation: GFZ German Research Centre for Geosciences
    - contributor (contributorType=ContactPerson)
      - contributorName: Lüdtke, Stefan
      - affiliation: GFZ German Research Centre for Geosciences
  - resourceType (resourceTypeGeneral=Software): Software
  - relatedIdentifiers
    - relatedIdentifier (relatedIdentifierType=URL relationType=IsVariantFormOf): https://git.geomar.de/digital-earth/floodsimilarity
    - relatedIdentifier (relatedIdentifierType=URL relationType=IsDocumentedBy): https://digital-earth.pages.geomar.de/floodsimilarity/
    - relatedIdentifier (relatedIdentifierType=URL relationType=References): https://www.digitalearth-hgf.de/
    - relatedIdentifier (relatedIdentifierType=DOI relationType=References): 10.5880/GFZ.1.4.2022.001
    - relatedIdentifier (relatedIdentifierType=DOI relationType=References): 10.5880/GFZ.1.4.2022.003
    - relatedIdentifier (relatedIdentifierType=DOI relationType=References): 10.5281/zenodo.5801319
  - sizes:
  - formats:
  - rightsList
    - rights (rightsURI=http://www.apache.org/licenses/LICENSE-2.0): Apache License, Version 2.0; Copyright (C) 2022 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences
  - descriptions
    - description (descriptionType=Abstract)
      - br:
      - br:
      - br:
      - br:
      - br:
    - description (descriptionType=TechnicalInfo)
      - br:
      - br:
      - br:
      - br:
  - fundingReferences
    - fundingReference
      - funderName: Alfred Wegener Institute Helmholtz Centre for Polar and Marine Research
      - funderIdentifier (funderIdentifierType=Crossref Funder ID): http://doi.org/10.13039/501100003207
      - awardTitle: Impuls- und Vernetzungsfond
iso19115: / download xml
- MD_Metadata (xsi:schemaLocation=http://www.isotc211.org/2005/gmd http://www.isotc211.org/2005/gmd/gmd.xsd)
  - fileIdentifier
    - CharacterString: 10.5880/GFZ.4.4.2022.001
  - language
    - LanguageCode (codeList=http://www.loc.gov/standards/iso639-2/ codeListValue=eng): eng
  - characterSet
    - MD_CharacterSetCode (codeListValue=utf8 codeList=http://www.isotc211.org/2005/resources/codeList.xml#MD_CharacterSetCode):
  - hierarchyLevel
    - MD_ScopeCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#MD_ScopeCode codeListValue=dataset): dataset
  - hierarchyLevelName
    - CharacterString:
  - contact
    - CI_ResponsibleParty
      - organisationName
        CharacterString: GFZ German Research Centre for Geosciences
      - contactInfo
        CI_Contact
        address
        CI_Address
        electronicMailAddress
        CharacterString: datapub(_at_)gfz-potsdam.de
        onlineResource
        CI_OnlineResource
        linkage
        URL: http://www.gfz-potsdam.de
        name
        CharacterString: Helmholtz-Centre Potsdam - GFZ German Research Centre for Geosciences
        description
        CharacterString: Helmholtz-Centre Potsdam - GFZ German Research Centre for Geosciences
      - role
        CI_RoleCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode codeListValue=pointOfContact): pointOfContact
  - dateStamp
    - Date: 2022-05-20
  - referenceSystemInfo
    - MD_ReferenceSystem
      - referenceSystemIdentifier
        RS_Identifier
        code
        CharacterString: urn:ogc:def:crs:EPSG:4326
  - identificationInfo
    - MD_DataIdentification
      - citation
        CI_Citation
        title
        CharacterString: floodsimilarity - a python module to compute the similarity between multiple flood events
        date
        CI_Date
        date
        Date: 2022-05-20
        dateType
        CI_DateTypeCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_DateTypeCode codeListValue=revision): revision
        identifier
        MD_Identifier
        code
        CharacterString: doi:10.5880/GFZ.4.4.2022.001
        citedResponsibleParty (xlink:href=http://orcid.org/0000-0002-7888-9175)
        CI_ResponsibleParty
        individualName
        CharacterString: Lüdtke, Stefan
        organisationName
        CharacterString: GFZ German Research Centre for Geosciences
        role
        CI_RoleCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode codeListValue=author): author
        citedResponsibleParty (xlink:href=http://orcid.org/0000-0003-0251-4390)
        CI_ResponsibleParty
        individualName
        CharacterString: Eggert, Daniel
        organisationName
        CharacterString: GFZ German Research Centre for Geosciences
        role
        CI_RoleCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode codeListValue=author): author
        citedResponsibleParty (xlink:href=http://orcid.org/0000-0002-9789-579X)
        CI_ResponsibleParty
        individualName
        CharacterString: Wendi, Dadiyorto
        organisationName
        CharacterString: GFZ German Research Centre for Geosciences
        role
        CI_RoleCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode codeListValue=author): author
        citedResponsibleParty (xlink:href=http://orcid.org/0000-0002-3173-7019)
        CI_ResponsibleParty
        individualName
        CharacterString: Schröter, Kai
        organisationName
        CharacterString: GFZ German Research Centre for Geosciences
        role
        CI_RoleCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode codeListValue=author): author
        citedResponsibleParty
        CI_ResponsibleParty
        organisationName
        CharacterString: GFZ Data Services
        role
        CI_RoleCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode codeListValue=publisher): publisher
      - abstract
        CharacterString: floodsimilarity provides classes and methods to conduct a similarity analysis between multiple flood events. The library mainly consists of two parts: (1) algorithms to compute indices and other statistics based on pandas and xarray (2) well-defined data structures for data exchange (e.g. through the Similarity Backend Module) floodsimilarity is used by the Digital Earth Similarity Backend Module (Eggert, 2021) as part of the Digital Earth Flood Event Explorer. It is developed at the GFZ German Research Centre for Geosciences and funded by the Initiative and Networking Fund of the Helmholtz Association through the Digital Earth project.
      - pointOfContact
        CI_ResponsibleParty
        individualName
        CharacterString: Lüdtke, Stefan
        organisationName
        CharacterString: GFZ German Research Centre for Geosciences
        contactInfo
        CI_Contact
        address
        CI_Address
        electronicMailAddress
        CharacterString: stefan.luedtke(_at_)gfz-potsdam.de
        role
        CI_RoleCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode codeListValue=pointOfContact): pointOfContact
      - descriptiveKeywords
        MD_Keywords
        keyword
        CharacterString: Digital Earth
        keyword
        CharacterString: Flood
        keyword
        CharacterString: Flood Event Explorer
      - descriptiveKeywords
        MD_Keywords
        keyword
        CharacterString: EARTH SCIENCE > TERRESTRIAL HYDROSPHERE > SURFACE WATER > FLOODS
        keyword
        CharacterString: EARTH SCIENCE > TERRESTRIAL HYDROSPHERE > SURFACE WATER > RUNOFF
        keyword
        CharacterString: EARTH SCIENCE SERVICES > DATA ANALYSIS AND VISUALIZATION
        thesaurusName
        CI_Citation
        title
        CharacterString: NASA/GCMD Earth Science Keywords
        date
        CI_Date
        date (gco:nilReason=missing):
        dateType
        CI_DateTypeCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_DateTypeCode codeListValue=publication): publication
      - resourceConstraints (xlink:href=http://www.apache.org/licenses/LICENSE-2.0)
        MD_Constraints
        useLimitation
        CharacterString: Apache License, Version 2.0; Copyright (C) 2022 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences
      - resourceConstraints
        MD_LegalConstraints
        accessConstraints
        MD_RestrictionCode (codeList=http://www.isotc211.org/2005/resources/codeList.xml#MD_RestrictionCode codeListValue=otherRestrictions):
        otherConstraints
        CharacterString: Apache License, Version 2.0; Copyright (C) 2022 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences
      - resourceConstraints
        MD_SecurityConstraints
        classification
        MD_ClassificationCode (codeList=http://www.isotc211.org/2005/resources/codeList.xml#MD_ClassificationCode codeListValue=unclassified):
      - aggregationInfo
        MD_AggregateInformation
        aggregateDataSetIdentifier
        RS_Identifier
        code
        CharacterString: https://git.geomar.de/digital-earth/floodsimilarity
        codeSpace
        CharacterString: URL
        associationType
        DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=IsVariantFormOf): IsVariantFormOf
      - aggregationInfo
        MD_AggregateInformation
        aggregateDataSetIdentifier
        RS_Identifier
        code
        CharacterString: https://digital-earth.pages.geomar.de/floodsimilarity/
        codeSpace
        CharacterString: URL
        associationType
        DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=IsDocumentedBy): IsDocumentedBy
      - aggregationInfo
        MD_AggregateInformation
        aggregateDataSetIdentifier
        RS_Identifier
        code
        CharacterString: https://www.digitalearth-hgf.de/
        codeSpace
        CharacterString: URL
        associationType
        DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=References): References
      - aggregationInfo
        MD_AggregateInformation
        aggregateDataSetIdentifier
        RS_Identifier
        code
        CharacterString: 10.5880/GFZ.1.4.2022.001
        codeSpace
        CharacterString: DOI
        associationType
        DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=References): References
      - aggregationInfo
        MD_AggregateInformation
        aggregateDataSetIdentifier
        RS_Identifier
        code
        CharacterString: 10.5880/GFZ.1.4.2022.003
        codeSpace
        CharacterString: DOI
        associationType
        DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=References): References
      - aggregationInfo
        MD_AggregateInformation
        aggregateDataSetIdentifier
        RS_Identifier
        code
        CharacterString: 10.5281/zenodo.5801319
        codeSpace
        CharacterString: DOI
        associationType
        DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=References): References
      - language
        CharacterString: eng
      - characterSet
        MD_CharacterSetCode (codeListValue=utf8 codeList=http://www.isotc211.org/2005/resources/codeList.xml#MD_CharacterSetCode):
      - topicCategory
        MD_TopicCategoryCode: geoscientificInformation
  - distributionInfo
    - MD_Distribution
      - transferOptions
        MD_DigitalTransferOptions
        onLine
        CI_OnlineResource
        linkage
        URL: http://doi.org/10.5880/GFZ.4.4.2022.001
        protocol
        CharacterString: WWW:LINK-1.0-http--link
        name
        CharacterString: Data Access - DOI
        description
        CharacterString: Data Access - DOI
        function
        CI_OnLineFunctionCode (codeList=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_OnLineFunctionCode codeListValue=http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_OnLineFunctionCode_information): information
  - dataQualityInfo
    - DQ_DataQuality
      - scope
        DQ_Scope
        level
        MD_ScopeCode (codeListValue=dataset codeList=http://www.isotc211.org/2005/resources/codeList.xml#MD_ScopeCode):

Files

Software Description

Documented by

https://digital-earth.pages.geomar.de/floodsimilarity/

Related Work

Variant Form of

https://git.geomar.de/digital-earth/floodsimilarity

References