YAML-StructuredData
5.1.1
  • Installing StructuredData
    • Parts of StructuredData
    • Requirements
    • Install from pypi with pip
    • Install from source (tar.gz or zip file)
      • Install as root to default directories
      • Install to a separate directory
      • Install in your home
  • Introduction
    • What is StructuredData ?
      • The concept
        • What kind of data can be stored ?
        • How is the data stored ?
        • How do I address parts of the data ?
        • How can I test the validity of the data ?
      • The software package
        • What does it do ?
        • Do I always have to use the software package ?
    • Applications of StructuredData
      • Where can StructuredData be useful ?
      • How does StructuredData support collaboration ?
      • Can graphs be represented in StructuredData ?
      • Can trees be represented in StructuredData ?
      • Can the data of a relational database represented in StructuredData ?
  • Comparisons to other concepts
    • Advantages of StructuredData compared to a database
    • Advantages of StructuredData compared to other text file formats
  • Reference
    • StructuredData in general
      • StructuredData terminology
      • References and links
      • Relation of Structured Data to python data structures
      • Paths
        • Joining a keylist to a path
        • Escape rules
        • Example
      • Patterns
        • Example
    • StructuredDataStore
    • StructuredDataTypes
      • Differences to programming language type declarations
      • Typepatterns
      • Typepattern matching
      • Type declarations
        • boolean
        • integer
        • real
        • string
        • optional struct
        • open struct
        • struct
        • typed map
        • map
        • optional list
        • typed list
        • list
    • StructuredDataContainer
  • SDpyshell
    • Introduction
    • Basic Syntax
      • function calls
      • procedure calls
      • string literals
    • Basic function
    • Command layers
    • Format Specifications
      • Structure Formats
      • Text formats
      • Marking links
      • Flat format
      • Dry run
    • Commands and Functions
      • Generic functions
        • help
          • help()
          • txt.help()
          • fun.help()
        • SDtype
          • fun.SDtype()
      • String and path functions
        • format
          • format()
          • txt.format()
        • string2pathkey
          • string2pathkey()
          • txt.string2pathkey()
          • fun.string2pathkey()
        • pathkey2string
          • pathkey2string()
          • txt.pathkey2string()
          • fun.pathkey2string()
        • splitpath
          • splitpath()
          • txt.splitpath()
          • fun.splitpath()
        • joinpath
          • joinpath()
          • txt.joinpath()
          • fun.joinpath()
        • combinepaths
          • combinepaths()
          • txt.combinepaths()
          • fun.combinepaths()
        • addpaths
          • addpaths()
          • txt.addpaths()
          • fun.addpaths()
        • poppath
          • poppath()
          • txt.poppath()
          • fun.poppath()
        • substpath
          • substpath()
          • txt.substpath()
          • fun.substpath()
      • Functions for the StructuredDataContainer
        • newsdc
          • fun.newsdc()
        • namedsdc
          • fun.namedsdc()
        • locksdc
          • fun.locksdc()
        • copy
          • copy()
          • txt.copy()
          • fun.copy()
      • File I/O
        • lockfile
          • fun.lockfile()
        • lockdir
          • fun.lockdir()
        • read
          • read()
          • txt.read()
          • fun.read()
        • write
          • write()
          • txt.write()
          • fun.write()
        • rewrite
          • rewrite()
      • Printing
        • pr
          • pr()
      • Generic functions for the StructuredDataStore
        • clear_store
          • clear_store()
          • txt.clear_store()
          • fun.clear_store()
        • refresh_links
          • refresh_links()
          • txt.refresh_links()
          • fun.refresh_links()
      • Generic functions for StructuredDataTypes
        • clear_types
          • clear_types()
          • txt.clear_types()
          • fun.clear_types()
      • Querying the data
        • paths
          • paths()
          • txt.paths()
          • fun.paths()
        • find
          • find()
          • txt.find()
          • fun.find()
        • ifind
          • ifind()
          • txt.ifind()
          • fun.ifind()
        • rxfind
          • rxfind()
          • txt.rxfind()
          • fun.rxfind()
        • findval
          • findval()
          • txt.findval()
          • fun.findval()
        • ifindval
          • ifindval()
          • txt.ifindval()
          • fun.ifindval()
        • rxfindval
          • rxfindval()
          • txt.rxfindval()
          • fun.rxfindval()
        • get
          • get()
          • txt.get()
          • fun.get()
        • getlinks
          • getlinks()
          • txt.getlinks()
          • fun.getlinks()
        • findlinks
          • findlinks()
          • txt.findlinks()
          • fun.findlinks()
      • Modifying the data
        • filter_out
          • filter_out()
          • txt.filter_out()
          • fun.filter_out()
        • change
          • change()
          • txt.change()
          • fun.change()
        • put
          • put()
          • txt.put()
          • fun.put()
        • delete
          • delete()
          • txt.delete()
          • fun.delete()
        • link
          • link()
          • txt.link()
          • fun.link()
      • Querying types
        • typepaths
          • typepaths()
          • txt.typepaths()
          • fun.typepaths()
        • typefind
          • typefind()
          • txt.typefind()
          • fun.typefind()
        • typeget
          • typeget()
          • txt.typeget()
          • fun.typeget()
      • Modifying types
        • typeput
          • typeput()
          • txt.typeput()
          • fun.typeput()
        • typeadditem
          • typeadditem()
          • txt.typeadditem()
          • fun.typeadditem()
        • typedelete
          • typedelete()
          • txt.typedelete()
          • fun.typedelete()
        • typedeleteitem
          • typedeleteitem()
          • txt.typedeleteitem()
          • fun.typedeleteitem()
      • Typechecking
        • typecheck
          • typecheck()
          • txt.typecheck()
          • fun.typecheck()
        • typematch
          • typematch()
          • txt.typematch()
          • fun.typematch()
    • Command aliases
    • Invoking SDpyshell
      • Precommands
      • Extensions
      • Server mode
      • Server password
      • Process management
  • SDpyshell Examples
    • Start the SDpyshell and read the data file
    • Reports with get
    • Reports with find
    • Reports with rxfind
    • Reports with findval
    • Reports with rxfindval
    • Reports with pr
    • Changing a single value with change
    • Adding a value with put
    • Working with links
    • Working with types
    • A change of many parameters with export and re-import
    • Converting a python structure to StructuredData
    • Converting a perl structure to StructuredData
  • SDxmlrpc
    • Introduction
      • What is XML-RPC ?
      • What is the difference between SDxmlrpc and SDpyshell ?
    • Basic function
      • The StructuredDataContainer key
      • Return values
    • Functions
    • Examples
      • Python
      • Perl
      • C
      • C++
    • Invoking SDxmlrpc
      • Precommands
      • Extensions
      • Process management
      • Restarting the server
  • SDview
    • Introduction
    • The start screen
    • The tree frame
    • The tree display frame
      • collapse all
      • expand all
      • collapse
      • expand
    • The search frame
      • The search type
        • pattern
        • ipattern
        • regexp
        • find value
        • ipattern find value
        • regexp find value
      • report only leaves
      • result window
        • no
        • show paths
        • show paths and values
  • Various ways of accessing the data
    • An example with SDpyshell
    • An example using the SDshellib
    • An example using StructuredData.Classes
    • An example with python and pure yaml
    • An example with perl and pure yaml
  • Python Modules
    • SDshelllib
    • SDshelllibTxt
    • SDshelllibFun
    • SDshelllibBase
    • SDshellrpclib
    • Classes
  • StructuredData License
YAML-StructuredData
  • »
  • Overview: module code

All modules for which code is available

  • StructuredData.Classes
  • StructuredData.SDshelllib
  • StructuredData.SDshelllibBase
  • StructuredData.SDshelllibFun
  • StructuredData.SDshelllibTxt
  • StructuredData.SDshellrpclib

© Copyright 2020, Helmholtz-Zentrum Berlin GmbH.

Built with Sphinx using a theme provided by Read the Docs.