Released
Software

Python Script HIPSTER v.1.3

Cite as:

Ziegler, Moritz O. (2021): Python Script HIPSTER v.1.3. GFZ Data Services. https://doi.org/10.5880/wsm.2021.001

Status

I   N       R   E   V   I   E   W : Ziegler, Moritz O. (2021): Python Script HIPSTER v.1.3. GFZ Data Services. https://doi.org/10.5880/wsm.2021.001

Abstract

In geosciences 3D geomechanical-numerical models are used to estimate the in-situ stress state. In such a model each geological unit is populated with the rock properties Young’s module, Poisson ratio, and density. Usually, each unit is assigned a single set of homogene-ous properties. However, variable rock properties are observed and expected within the same geological unit. Even within small volumes large variabilities may occur.



The Python script HIPSTER (Homogeneous to Inhomogeneous rock Properties for Stress TEnsor Research) provides an algorithm to include inhomogeneities in geomechanical-numerical models that use the solver Abaqus® or the MOOSE Framework. The user specifies the mean values for the rock properties Young's module, Poisson ratio and density, and their variability for each geological unit. The variability of the material properties is indi-vidually defined for each of the three rock properties in each geological layer. For each unit or unit subset HIPSTER generates a normal or uniform distribution for each rock property. From these distributions for each single element or subset of elements HIPSTER draws indi-vidual rock properties and writes them to a separate material file. This file defines differ-ent material properties for each element. The file is included in the geomechanical-numerical analysis solver deck and the numerical model is solved as usual.



HIPSTER is fully documented in the associated data report (Ziegler, 2021, https://doi.org/10.48440/wsm.2021.001) and can also be accessed at Github (http://github.com/MorZieg/hipster).


Additional Information

28 January 2021: Release of Version 1.3

Changelog v1.3



The following changes have been implemented compared to Version 1.01:



• Due to the end of the support for Python 2.x HIPSTER has been updated to run with Python 3.x.



• In addition to the assignment of material properties to individual elements, HIPSTER is now able to assign material properties to element sets as well.



• The range of output files has been extended to include the syntax of the MOOSE Framework.



• Several minor improvements in functionality and readability have been included:

− The main function has been cleaned and code was outsourced.

− A sanity check for the provided input is included.

− Several functions were cleaned and made more comprehensive.

− Additional comments have been included.


Authors

Contact

    Funders

  • Bundesministerium für Bildung und Forschung: SUBI (FONA/GEO:N)  (03G0869A)  
  • Helmholtz-Gemeinschaft: iCross  (02NUK053D)  
  • Bundesministerium für Bildung und Forschung: iCross  (02NUK053D)  

Keywords

geomechanical-numerical model, stress, in-situ stress, modelling tool, finite-elemeent model, inhomogeneities

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/wsm.2021.001
      • creators
        • creator
          • creatorName (nameType=Personal): Ziegler, Moritz O.
          • givenName: Moritz O.
          • familyName: Ziegler
          • nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-2288-2820
          • affiliation (affiliationIdentifier=0000-0002-2288-2820 affiliationIdentifierScheme=ORCID): GFZ German Research Centre for Geosciences, Potsdam, Germany
      • titles
        • title: Python Script HIPSTER v.1.3
      • publisher: GFZ Data Services
      • publicationYear: 2021
      • subjects
        • subject: geomechanical-numerical model
        • subject: stress
        • subject: in-situ stress
        • subject: modelling tool
        • subject: finite-elemeent model
        • subject: inhomogeneities
        • subject (subjectScheme=NASA/GCMD Earth Science Keywords): EARTH SCIENCE > SOLID EARTH > TECTONICS > NEOTECTONICS
        • subject (subjectScheme=NASA/GCMD Earth Science Keywords): EARTH SCIENCE > SOLID EARTH > TECTONICS > PLATE TECTONICS > CRUSTAL MOTION > CRUSTAL MOTION DIRECTION
        • subject (subjectScheme=NASA/GCMD Earth Science Keywords): EARTH SCIENCE > SOLID EARTH > TECTONICS > PLATE TECTONICS > FAULT MOVEMENT
        • subject (subjectScheme=NASA/GCMD Earth Science Keywords): EARTH SCIENCE > SOLID EARTH > TECTONICS > PLATE TECTONICS > PLATE BOUNDARIES
        • subject (subjectScheme=NASA/GCMD Earth Science Keywords): EARTH SCIENCE > SOLID EARTH > TECTONICS > PLATE TECTONICS > STRESS
      • contributors
        • contributor (contributorType=Editor)
          • contributorName (nameType=Personal): Ziegler, Moritz O.
          • givenName: Moritz O.
          • familyName: Ziegler
          • nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-2288-2820
          • affiliation (affiliationIdentifier=0000-0002-2288-2820 affiliationIdentifierScheme=ORCID): GFZ German Research Centre for Geosciences, Potsdam, Germany
        • contributor (contributorType=Researcher)
          • contributorName (nameType=Personal): Ziegler, Moritz O.
          • givenName: Moritz O.
          • familyName: Ziegler
          • nameIdentifier (nameIdentifierScheme=ORCID): 0000-0002-2288-2820
          • affiliation (affiliationIdentifier=0000-0002-2288-2820 affiliationIdentifierScheme=ORCID): GFZ German Research Centre for Geosciences, Potsdam, Germany
        • contributor (contributorType=ContactPerson)
          • contributorName: Ziegler, Moritz O.
          • affiliation (affiliationIdentifier= affiliationIdentifierScheme=): GFZ German Research Centre for Geosciences, Potsdam, Germany
        • contributor (contributorType=ContactPerson)
          • contributorName: Ziegler, Moritz O.
          • affiliation (affiliationIdentifier= affiliationIdentifierScheme=): GFZ German Research Centre for Geosciences, Potsdam, Germany
      • resourceType (resourceTypeGeneral=Software): Software
      • relatedIdentifiers
        • relatedIdentifier (relatedIdentifierType=DOI relationType=Cites): 10.5880/wsm.2020.002
        • relatedIdentifier (relatedIdentifierType=DOI relationType=IsNewVersionOf): 10.5880/wsm.2019.003
        • relatedIdentifier (relatedIdentifierType=DOI relationType=Cites): 10.5880/wsm.2018.003
        • relatedIdentifier (relatedIdentifierType=URL relationType=IsVariantFormOf): http://github.com/MorZieg/hipster
        • relatedIdentifier (relatedIdentifierType=DOI relationType=IsDocumentedBy): 10.48440/wsm.2021.001
      • sizes: 
      • formats: 
      • rightsList
        • rights (rightsURI=https://www.gnu.org/licenses/gpl-3.0.html): GNU General Public License, Version 3, 29 June 2007 Copyright © 2021 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany
      • descriptions
        • description (descriptionType=Abstract)
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
        • description (descriptionType=Other)
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
          • br: 
      • fundingReferences
        • fundingReference
          • funderName: Bundesministerium für Bildung und Forschung
          • funderIdentifier (funderIdentifierType=Crossref Funder ID): http://doi.org/10.13039/501100002347
          • awardNumber: 03G0869A
          • awardTitle: SUBI (FONA/GEO:N)
        • fundingReference
          • funderName: Helmholtz-Gemeinschaft
          • funderIdentifier (funderIdentifierType=Crossref Funder ID): http://doi.org/10.13039/501100001656
          • awardNumber: 02NUK053D
          • awardTitle: iCross
        • fundingReference
          • funderName: Bundesministerium für Bildung und Forschung
          • funderIdentifier (funderIdentifierType=Crossref Funder ID): http://doi.org/10.13039/501100002347
          • awardNumber: 02NUK053D
          • awardTitle: iCross
  • 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/wsm.2021.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: 2021-02-04
      • referenceSystemInfo
        • MD_ReferenceSystem
          • referenceSystemIdentifier
            • RS_Identifier
              • code
                • CharacterString: urn:ogc:def:crs:EPSG:4326
      • identificationInfo
        • MD_DataIdentification
          • citation
            • CI_Citation
              • title
                • CharacterString: Python Script HIPSTER v.1.3
              • date
                • CI_Date
                  • date
                    • Date: 2021-02-04
                  • 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/wsm.2021.001
              • citedResponsibleParty (xlink:href=http://orcid.org/0000-0002-2288-2820)
                • CI_ResponsibleParty
                  • individualName
                    • CharacterString: Ziegler, Moritz O.
                  • organisationName
                    • CharacterString: GFZ German Research Centre for Geosciences, Potsdam, Germany
                  • 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: In geosciences 3D geomechanical-numerical models are used to estimate the in-situ stress state. In such a model each geological unit is populated with the rock properties Young’s module, Poisson ratio, and density. Usually, each unit is assigned a single set of homogene-ous properties. However, variable rock properties are observed and expected within the same geological unit. Even within small volumes large variabilities may occur. The Python script HIPSTER (Homogeneous to Inhomogeneous rock Properties for Stress TEnsor Research) provides an algorithm to include inhomogeneities in geomechanical-numerical models that use the solver Abaqus® or the MOOSE Framework. The user specifies the mean values for the rock properties Young's module, Poisson ratio and density, and their variability for each geological unit. The variability of the material properties is indi-vidually defined for each of the three rock properties in each geological layer. For each unit or unit subset HIPSTER generates a normal or uniform distribution for each rock property. From these distributions for each single element or subset of elements HIPSTER draws indi-vidual rock properties and writes them to a separate material file. This file defines differ-ent material properties for each element. The file is included in the geomechanical-numerical analysis solver deck and the numerical model is solved as usual. HIPSTER is fully documented in the associated data report (Ziegler, 2021, https://doi.org/10.48440/wsm.2021.001) and can also be accessed at Github (http://github.com/MorZieg/hipster).
          • pointOfContact
            • CI_ResponsibleParty
              • individualName
                • CharacterString: Ziegler, Moritz O.
              • organisationName
                • CharacterString: GFZ German Research Centre for Geosciences, Potsdam, Germany
              • contactInfo
                • CI_Contact
                  • address
                    • CI_Address
                      • electronicMailAddress
                        • CharacterString: mziegler(_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: geomechanical-numerical model
              • keyword
                • CharacterString: stress
              • keyword
                • CharacterString: in-situ stress
              • keyword
                • CharacterString: modelling tool
              • keyword
                • CharacterString: finite-elemeent model
              • keyword
                • CharacterString: inhomogeneities
          • descriptiveKeywords
            • MD_Keywords
              • keyword
                • CharacterString: EARTH SCIENCE > SOLID EARTH > TECTONICS > NEOTECTONICS
              • keyword
                • CharacterString: EARTH SCIENCE > SOLID EARTH > TECTONICS > PLATE TECTONICS > CRUSTAL MOTION > CRUSTAL MOTION DIRECTION
              • keyword
                • CharacterString: EARTH SCIENCE > SOLID EARTH > TECTONICS > PLATE TECTONICS > FAULT MOVEMENT
              • keyword
                • CharacterString: EARTH SCIENCE > SOLID EARTH > TECTONICS > PLATE TECTONICS > PLATE BOUNDARIES
              • keyword
                • CharacterString: EARTH SCIENCE > SOLID EARTH > TECTONICS > PLATE TECTONICS > STRESS
              • 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=https://www.gnu.org/licenses/gpl-3.0.html)
            • MD_Constraints
              • useLimitation
                • CharacterString: GNU General Public License, Version 3, 29 June 2007 Copyright © 2021 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany
          • resourceConstraints
            • MD_LegalConstraints
              • accessConstraints
                • MD_RestrictionCode (codeList=http://www.isotc211.org/2005/resources/codeList.xml#MD_RestrictionCode codeListValue=otherRestrictions): 
              • otherConstraints
                • CharacterString: GNU General Public License, Version 3, 29 June 2007 Copyright © 2021 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany
          • 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: 10.5880/wsm.2020.002
                  • codeSpace
                    • CharacterString: DOI
              • associationType
                • DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=Cites): Cites
          • aggregationInfo
            • MD_AggregateInformation
              • aggregateDataSetIdentifier
                • RS_Identifier
                  • code
                    • CharacterString: 10.5880/wsm.2019.003
                  • codeSpace
                    • CharacterString: DOI
              • associationType
                • DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=IsNewVersionOf): IsNewVersionOf
          • aggregationInfo
            • MD_AggregateInformation
              • aggregateDataSetIdentifier
                • RS_Identifier
                  • code
                    • CharacterString: 10.5880/wsm.2018.003
                  • codeSpace
                    • CharacterString: DOI
              • associationType
                • DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=Cites): Cites
          • aggregationInfo
            • MD_AggregateInformation
              • aggregateDataSetIdentifier
                • RS_Identifier
                  • code
                    • CharacterString: http://github.com/MorZieg/hipster
                  • codeSpace
                    • CharacterString: URL
              • associationType
                • DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=IsVariantFormOf): IsVariantFormOf
          • aggregationInfo
            • MD_AggregateInformation
              • aggregateDataSetIdentifier
                • RS_Identifier
                  • code
                    • CharacterString: 10.48440/wsm.2021.001
                  • codeSpace
                    • CharacterString: DOI
              • associationType
                • DS_AssociationTypeCode (codeList=http://datacite.org/schema/kernel-4 codeListValue=IsDocumentedBy): IsDocumentedBy
          • 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/wsm.2021.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): 
  • schema.org download

Files

License: GNU General Public License, Version 3, 29 June 2007 Copyright © 2021 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany

Software Description

Documented by