aboutsummaryrefslogtreecommitdiff
path: root/backend/tolData/eol/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'backend/tolData/eol/README.md')
-rw-r--r--backend/tolData/eol/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/backend/tolData/eol/README.md b/backend/tolData/eol/README.md
new file mode 100644
index 0000000..8c527a8
--- /dev/null
+++ b/backend/tolData/eol/README.md
@@ -0,0 +1,26 @@
+This directory holds files obtained from/using the [Encyclopedia of Life](https://eol.org/).
+
+# Name Data Files
+- vernacularNames.csv <br>
+ Obtained from <https://opendata.eol.org/dataset/vernacular-names> on 24/04/2022 (last updated on 27/10/2020).
+ Contains alternative-name data from EOL.
+
+# Image Metadata Files
+- imagesList.tgz <br>
+ Obtained from <https://opendata.eol.org/dataset/images-list> on 24/04/2022 (last updated on 05/02/2020).
+ Contains metadata for images from EOL.
+- imagesList/ <br>
+ Extracted from imagesList.tgz.
+- genImagesListDb.sh <br>
+ Creates a database, and imports imagesList/*.csv files into it.
+- imagesList.db <br>
+ Created by running genImagesListDb.sh <br>
+ Tables: <br>
+ - `images`:
+ `content_id INT PRIMARY KEY, page_id INT, source_url TEXT, copy_url TEXT, license TEXT, copyright_owner TEXT`
+
+# Image Generation Files
+- downloadImgs.py <br>
+ Used to download image files into imgsForReview/.
+- reviewImgs.py <br>
+ Used to review images in imgsForReview/, moving acceptable ones into imgs/.