Skip to content

v0.2.47..v0.2.48 changeset HootenannyGrailNotes.asciidoc

Garret Voltz edited this page Sep 27, 2019 · 1 revision
diff --git a/docs/developer/HootenannyGrailNotes.asciidoc b/docs/developer/HootenannyGrailNotes.asciidoc
index aa1051e..e969a29 100644
--- a/docs/developer/HootenannyGrailNotes.asciidoc
+++ b/docs/developer/HootenannyGrailNotes.asciidoc
@@ -1,9 +1,35 @@
-
 == Grail work notes
 
-There are various operations we labeled as 'grail' work and these notes should be used as a reminder of implementation
+There are various operations we labeled as 'grail' work and these notes should be used as a reminder of
 implementation decisions.
 
-=== Grail pull from OSM and MapEdit
+=== Grail pull from OSM Overpass and the Rails Port
+
+Under the tools section in the Hootenanny UI there will be a section labeled "Grail Tools". Under that
+you should see the option to "Pull Remote Data". Once selected you will be prompted to select a bounding
+box region by either drawing the bounding box or using the visual extent as your bounding box. Once selected
+you can submit the job for running. After the job has completed you should see a folder with the name of
+grail_*coordinates for your bounding box* which should contain a filed named "reference" (the Rails Port data)
+and a file named "secondary" (the OSM Overpass data).
+
+
+=== Derive Differential Changeset
+
+Under the tools section in the Hootenanny UI there will be a section labeled "Grail Tools". Under that
+you should see the option for "Derive Differential Changeset". This tool is used for gathering only the data
+in OSM Overpass that isn't already in the Rails Port and pushing it to the Rails Port so it will only consist of adds. There will not
+be any files generated that you can view in the UI because this service will take the OSM Overpass and the Rails Port data from
+the database and calculate the differential on the server without saving the datasets. While the datasets will not
+be saved, an osm file will be generated on the server.
+In the jobs panel you can find the Derive Changeset job and under the actions there will be a cloud icon with an up arrow.
+This is what you use to upload the differential results to the Rails Port, but before doing that you can view stats on the differential
+upload. The stats will include the counts of create, modify, and delete for nodes, ways, and relations.
+The differential will not contain any secondary features involved in a review.
 
+=== Grail Conflate
 
+The result of a conflation job, where the reference dataset is the result of a grail pull, becomes grail conflate
+eligible. In the jobs panel you will see under actions a triangle icon, the same icon that is to the left
+of a derive changeset job type. If you click this a derive changeset job will kick off and the result of
+that job is what you can upload to the Rails Port. This will be similar to differential changeset, but it will
+include modify and deletes alongside the potential adds.
Clone this wiki locally