aboutsummaryrefslogtreecommitdiff
path: root/backend/data/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'backend/data/README.md')
-rw-r--r--backend/data/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/backend/data/README.md b/backend/data/README.md
new file mode 100644
index 0000000..3cbeb03
--- /dev/null
+++ b/backend/data/README.md
@@ -0,0 +1,13 @@
+File Generation Process
+=======================
+1 Obtain data in otol/ and eol/, as specified in their README files.
+2 Run genOtolData.py, which creates data.db, and adds a 'nodes'
+ table using data in otol/*.
+3 Run genEolNameData.py, which adds a 'names' table to data.db,
+ using data in eol/vernacularNames.csv and the 'nodes' table.
+4 Use downloadImgsForReview.py to download EOL images into imgsForReview/.
+ It uses data in eol/imagesList.db, and the 'nodes' table.
+5 Use reviewImgs.py to filter images in imgsForReview/ into EOL-id-unique
+ images in imgsReviewed/.
+6 Use genImgsForWeb.py to create cropped/resized images in img/, using
+ images in imgsReviewed, and also to add an 'images' table to data.db.