Changes between Version 6 and Version 7 of FaultSystemSolution


Ignore:
Timestamp:
Aug 1, 2013, 3:02:39 PM (11 years ago)
Author:
Kevin Milner
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • FaultSystemSolution

    v6 v7  
    22
    33UCERF3 (and potentially other forecast) data is stored in a zip file format, this page describes how to parse these zip files. If you are using Java, a parser is already written in OpenSHA via the [source:trunk/dev/scratch/UCERF3/utils/FaultSystemIO.java scratch.UCERF3.utils.FaultSystemIO] class.
     4
     5== Zip File Contents ==
     6
     7The following files constitute a Fault System Solution. See File Formats below for descriptions and implementation details for each format.
     8
     9||= File Name =||= File Format =||= Optional? =||= Description =||
     10||'''fault_sections.xml'''||XML (see above)||no||This XML file describes each sub section in the Fault System. These indexes will be referred to in the rup_sections.bin file when defining ruptures.||
     11||'''grid_sources.xml'''||XML (see above)||yes||This XML file, if present, gives gridded seismicity MFDs at each node in the region that this solution covers.||
     12||'''info.txt'''||ASCII||yes||This text file, if present, contains metadata describing the solution.||
     13||'''mags.bin'''||Double array binary||no||This file gives magnitudes for each rupture. It contains one double value for each rupture index, in order.||
     14||'''rakes.bin'''||Double array binary||no||This file gives average rakes for each rupture. It contains one double value for each rupture index, in order.||
     15||'''rates.bin'''||Double array binary||no||This file gives annualized rates for each rupture. It contains one double value for each rupture index, in order.||
     16||'''rup_areas.bin'''||Double array binary||no||This file gives areas for each rupture in SI units (square meters). It contains one double value for each rupture index, in order.||
     17||'''rup_lengths.bin'''||Double array binary||yes||This file, if present, gives lengths for each rupture in SI units (meters). It contains one double value for each rupture index, in order.||
     18||'''rup_mfds.bin'''||MFD Binary||yes||This file, if present, magnitude frequency distributions for each rupture. It contains one function (consisting of an x value and y value data array) for each rupture index, in order.||
     19||'''rup_sections.bin'''||Integer array list binary||no||This lists the sub sections involved in each rupture. It consists of numRuptures arrays, each of which lists the sub sections indexes (as defined in fault_sections.xml) for that rupture||
     20||'''sect_areas.bin'''||Double array binary||yes||This file, if present, gives areas for each fault sub section in SI units (square meters). It contains one double value for each sub section index, in order.||
     21||'''sect_slips.bin'''||Double array binary||yes||This file, if present, gives slip rates after any aseismic and subseismogenic reductions for each fault sub section in SI units (square meters). It contains one double value for each sub section index, in order.||
     22||'''sect_slips_std_dev.bin'''||Double array binary||yes||This file, if present, gives standard deviations of slip rates after any aseismic and subseismogenic reductions for each fault sub section in SI units (square meters). It contains one double value for each sub section index, in order.||
     23
     24
     25The following files are neither documented nor required but may be present in zip files generated by the UCERF3 inversion. They give metadata about the logic tree branch associated and other inversion metadata.
     26||= File Name =||= File Format =||= Optional? =||= Description =||
     27||'''close_sections.bin'''||Integer array list binary||yes||This file lists, for each sub section (in order), all of the other sub sections that the given sub section connects with in the Fault System.||
     28||'''cluster_rups.bin'''||Integer array list binary||yes||Some fault systems are separated into clusters of interconnected faults. This file lists, for each cluster, all of the rupture indexes which are part of the given cluster.||
     29||'''cluster_sects.bin'''||Integer array list binary||yes||Some fault systems are separated into clusters of interconnected faults. This file lists, for each cluster, all of the sub section indexes which are part of the given cluster.||
     30||'''inv_rup_set_metadata.xml'''||XML||yes||This file gives metadata for the logic tree branch and rupture filtration criterion (laugh test filter) used to generate this solution.||
     31||'''inv_sol_metadata.xml'''||XML||yes||This file gives metadata for the UCERF3 inversion including equation set weights and final simulated annealing energies.||
     32||'''rup_avg_slips.bin'''||Double array binary||yes||This file, if present, gives the average slip for each rupture in SI units (meters). It contains one double value for each rupture index, in order.||
     33
    434
    535== File Formats Used ==
    … …  
    172202
    173203In this example, '''[[span(style=color: #FF0000, the number of arrays (2 * the number of functions, interger) is in red)]]''', '''[[span(style=color: #0000FF, each array's size (integer) in blue)]]''', '''[[span(style=color: #00FFFF, x value array data (double values) are in cyan)]]''', and '''[[span(style=color: #FFBF00, y value array data (double values) are in orange)]]'''.
    174 
    175 == Zip File Contents ==
    176 
    177 The following files constitute a Fault System Solution
    178 
    179 ||= File Name =||= File Format =||= Optional? =||= Description =||
    180 ||'''fault_sections.xml'''||XML (see above)||no||This XML file describes each sub section in the Fault System. These indexes will be referred to in the rup_sections.bin file when defining ruptures.||
    181 ||'''grid_sources.xml'''||XML (see above)||yes||This XML file, if present, gives gridded seismicity MFDs at each node in the region that this solution covers.||
    182 ||'''info.txt'''||ASCII||yes||This text file, if present, contains metadata describing the solution.||
    183 ||'''mags.bin'''||Double array binary||no||This file gives magnitudes for each rupture. It contains one double value for each rupture index, in order.||
    184 ||'''rakes.bin'''||Double array binary||no||This file gives average rakes for each rupture. It contains one double value for each rupture index, in order.||
    185 ||'''rates.bin'''||Double array binary||no||This file gives annualized rates for each rupture. It contains one double value for each rupture index, in order.||
    186 ||'''rup_areas.bin'''||Double array binary||no||This file gives areas for each rupture in SI units (square meters). It contains one double value for each rupture index, in order.||
    187 ||'''rup_lengths.bin'''||Double array binary||yes||This file, if present, gives lengths for each rupture in SI units (meters). It contains one double value for each rupture index, in order.||
    188 ||'''rup_mfds.bin'''||MFD Binary||yes||This file, if present, magnitude frequency distributions for each rupture. It contains one function (consisting of an x value and y value data array) for each rupture index, in order.||
    189 ||'''rup_sections.bin'''||Integer array list binary||no||This lists the sub sections involved in each rupture. It consists of numRuptures arrays, each of which lists the sub sections indexes (as defined in fault_sections.xml) for that rupture||
    190 ||'''sect_areas.bin'''||Double array binary||yes||This file, if present, gives areas for each fault sub section in SI units (square meters). It contains one double value for each sub section index, in order.||
    191 ||'''sect_slips.bin'''||Double array binary||yes||This file, if present, gives slip rates after any aseismic and subseismogenic reductions for each fault sub section in SI units (square meters). It contains one double value for each sub section index, in order.||
    192 ||'''sect_slips_std_dev.bin'''||Double array binary||yes||This file, if present, gives standard deviations of slip rates after any aseismic and subseismogenic reductions for each fault sub section in SI units (square meters). It contains one double value for each sub section index, in order.||
    193 
    194 
    195 The following files are neither documented nor required but may be present in zip files generated by the UCERF3 inversion. They give metadata about the logic tree branch associated and other inversion metadata.
    196 ||= File Name =||= File Format =||= Optional? =||= Description =||
    197 ||'''close_sections.bin'''||Integer array list binary||yes||This file lists, for each sub section (in order), all of the other sub sections that the given sub section connects with in the Fault System.||
    198 ||'''cluster_rups.bin'''||Integer array list binary||yes||Some fault systems are separated into clusters of interconnected faults. This file lists, for each cluster, all of the rupture indexes which are part of the given cluster.||
    199 ||'''cluster_sects.bin'''||Integer array list binary||yes||Some fault systems are separated into clusters of interconnected faults. This file lists, for each cluster, all of the sub section indexes which are part of the given cluster.||
    200 ||'''inv_rup_set_metadata.xml'''||XML||yes||This file gives metadata for the logic tree branch and rupture filtration criterion (laugh test filter) used to generate this solution.||
    201 ||'''inv_sol_metadata.xml'''||XML||yes||This file gives metadata for the UCERF3 inversion including equation set weights and final simulated annealing energies.||
    202 ||'''rup_avg_slips.bin'''||Double array binary||yes||This file, if present, gives the average slip for each rupture in SI units (meters). It contains one double value for each rupture index, in order.||