source: main/trunk/model-sites-dev/eurovision-lod/collect/eurovision/prepare/README.txt@ 35869

Last change on this file since 35869 was 35869, checked in by davidb, 2 years ago

Summarized some of the details given, as now covered off by a ALL-CAPS convenience script

File size: 2.1 KB
Line 
1
2# Local Config Settings
3
4Open in a text editor, for example:
5
6 emacs _local_prepare_config.sh
7
8review and edit appropriately.
9
10If you plan to use the Spotify based 'Track a' for MIR-based features,
11then create an appropriate Spotify API credentials through:
12
13 https://developer.spotify.com/dashboard/applications
14
15Otherwise you can use 'Track b' which -- proxied through the
16eurovisionworld.com fan web site -- page scrapes YouTube content of
17the songs, and then goes through a process using ffmpeg and essentia
18to generate audio features. No key setup is needed if Track b.
19
20
21# Setup a Virtual Python3 Environment
22
23Next create a virtual Python environment:
24
25 ./CREATE-VENV-PYTHON3.sh my-python3-dev
26
27And then install required Python packages:
28
29 * For processing Excel Voting data spreadsheet
30 pip3 install openpyxl
31
32 * For parsing Wikipeida pages for missing category entries
33 pip3 install wikipedia beautifulsoup4
34
35 * For Spotify/MusicBrainz musically computed audio content (Track 'a')
36 pip3 install -r spotify-musicbrainz/requirements.txt
37
38 * For Essentia Audio Features (Track 'b')
39
40 git clone https://github.com/davidbwaikato/eurovision-dataset essentia-audio-features
41
42 pip3 install -r essentia-audio-features/requirements.txt
43
44
45# Running the ALL-CAPS scripts
46
47The prefix to the scripts to run are sequentially numbers 01-...,
4802-... and so on.
49
50The (personal) convention of using ALL-CAPS is to signify that these scripts
51can be run without any arguments and they will do something meaningful, with
52the caveat that the current working directory must be the directory where
53the scripts are located.
54
55To aid development and testing, there is a 'small' set of files that
56can be prepared, based on only the Eurovision entries for 2015.
57
58You can run all the steps to generate the small version with:
59
60 ./PREPARE-ALL-SMALL.sh
61
62Or else generate the data for the full collection with
63
64 ./PREPARE-ALL.sh
65
66Look inside the scripts, and copy and paste just the bits you want to
67run smaller segements of the prepare process.
68
69With the a complete run through done, move up one directory to the
70main collection directory and build the collection.
71
72
73
74
75
Note: See TracBrowser for help on using the repository browser.