Merge pull request #79 from WildMeOrg/id-pathways

ia pathways docs

docs/_static/custom.css

@@ -11,21 +11,25 @@ html[data-theme='light'] {
 }
 
 html[data-theme='dark'] a {
-    color:#0267FD;
+    color:#007599;
+    text-decoration: none;
 }
 
 html[data-theme='dark'] a:hover {
     color:#007599;
+    text-decoration: underline;
 }
 
 html [data-theme='dark'] .search-button-field {
     background-color: #18191B;
 }
 
 html[data-theme='light'] a {
-    color:#0267FD;
+    color:#007599;
+    text-decoration: none;
 }
 
 html[data-theme='light'] a:hover {
     color:#007599;
+    text-decoration: underline;
 }

docs/contribute/ia-dev.md

@@ -0,0 +1,47 @@
+# Image Analysis Development
+
+## Code Pathways to IA
+
+### Single Encounter Submission
+1. User starts on submit.jsp
+2. `EncounterForm`
+  - `IA.intakeMediaAssets(myShepherd, enc.getMedia().parentTask);`
+  - `IA. intakeMediaAssetsOneSpecies(myShepherd, assetsBySpecies.get(0), parentTask);`
+  - `intakeMediaAssetsOneSpecies(myShepherd, mas, taxy, parentTask);	`
+  - `intakeMediaAssetsOneSpecies(Shepherd myShepherd, List<MediaAsset> mas,Taxonomy taxy, final Task parentTask, int tweetAssetId)`
+  - `IAGateway.addToDetectionQueue(context,qjob.toString());`
+3. WBIA detection occurs independently
+4. `IBEISIA.processCallback`
+  - `processCallbackDetect(...)`
+  - `IA.intakeAnnotations(myShepherd2, needIdentifying, parentTask, false);`
+  - `IAGateway.addToQueue(context, qjob.toString());`
+5. `IBEISIA.processCallback`
+  - `IBEISIA.processCallbackIdentify`
+6. Results visible from "match results" button on annotation on Encounter page
+
+### Bulk Import
+_Assumes bulk detection on the ImportTask has already occurred._
+
+1. User has completed a bulk import and is looking at it on the related import.jsp page.
+2. `resendBulkImportID.jsp`
+  - `IA.intakeAnnotations(myShepherd, matchMeAnns, subParentTask,false);`
+  - `IAGateway.addToQueue(context, qjob.toString());`
+3. Queue (“IA”) sends to WBIA
+4. `IBEISIA.processCallback` when job returned by WBIA to /ia
+  - `IBEISIA.processCallbackIdentify`
+5. Results visible from “match results” button on annotation on an imported Encounter page or from the import.jsp for the bulk import.
+
+### Manual 'Start Match' from Encounter Page
+_Assumes detection has already run, and annotations already exist._
+
+1. User clicks “start match” or “start another match”  from encounter.jsp
+  - `encounter.jsp.iaMatchFilterGo(...)`
+  - `ia.IBEIS.js.restCall(...)`
+2. `IAGateway.java`
+  - doPost
+  - `if (j.optBoolean("enqueue", false) || j.optBoolean("v2", false)) { `
+  - `addToDetectionQueue(context, j.toString());` or `addToQueue (...)` depending on fastlane status
+3. Queue (“detection”/fastlane) - except for HotSpotter jobs which are sent to “IA” queue sends to WBIA
+4. `IBEISIA.processCallback` when job returned by WBIA to /ia
+  - `IBEISIA.processCallbackIdentify`
+5. Results visible from “match results” button on annotation on Encounter page

docs/contribute/index.md

@@ -6,6 +6,7 @@
 dev-setup
 pr-workflow
 code-guide
+ia-dev
 copy-guide
 roadmap
 ```

docs/index.md

@@ -19,4 +19,9 @@ Want to put your talents to use fighting the 6th mass extinction? We're excited
 
 ```{toctree}
 contribute/index
+contribute/dev-setup
+contribute/pr-workflow
+contribute/code-guide
+contribute/copy-guide
+contribute/roadmap
 ```