candidate fault association product for ComCat #134
Conversation
Codecov Report
@@ Coverage Diff @@
## master #134 +/- ##
==========================================
- Coverage 51.85% 51.85% -0.01%
==========================================
Files 214 214
Lines 16665 16665
Branches 2539 2539
==========================================
- Hits 8642 8641 -1
Misses 7072 7072
- Partials 951 952 +1
Continue to review full report at Codecov.
|
| { | ||
| "type": "Feature", | ||
| "properties": { | ||
| "class": "event", |
There was a problem hiding this comment.
I thought we discussed moving the event feature to metadata, so the feature collection would only be faults.
| </dl> | ||
|
|
||
| <h2>JSON Format</h2> | ||
| <p>The JSON file is an extension of GEOJSON standard and contains an array of a metadata object, a result object, and |
There was a problem hiding this comment.
array is a little misleading. I would say something like:
faultassociations.jsonis a GeoJson FeatureCollection of fault associations, and includes additionalmetadataandresultattributes that summarize inputs and results.
When referencing filenames or attributes/properties, I recommend using an html code element, for example:
<code>faultassociations.json</code>
| }</pre></div> | ||
|
|
||
| -------------------- | ||
| <h2>Contents</h2> |
There was a problem hiding this comment.
There should be one contents list, briefly describing all contents, and then you can add example sections at the end of the page.
| -------------------- | ||
| <h2>Contents</h2> | ||
| <dl> | ||
| <dt>Input_Earthquakes_to_Eval.csv</dt> |
There was a problem hiding this comment.
It may be worth listing the expected and/or optional columns for each file.
| probabilities apply. | ||
| The feature collection comprises of one or more fault features and their association probabilites and distance from the event. | ||
|
|
||
| <h3>Metadata Object</h3> |
There was a problem hiding this comment.
You can use nesting to document specific properties, for example:
<dl>
<dt>Result</dt>
<dd>
Array of summary results, sorted most probable first. Each result includes the following properties:
<dl>
<dt>probability</dt>
<dd>The probability of this specific result</dd>
<dt>title</dt>
<dd>Description of the result, either a fault name or a category like "Not in CFM"</dd>
</dl>
</dd>
...
</dl>
This is describes a product that contains the probabilities that an event is associated with a fault.