Project

General

Profile

1 702 aaronmk
Installation:
2 6886 aaronmk
    Check out svn: svn co https://code.nceas.ucsb.edu/code/projects/bien
3 6887 aaronmk
    cd bien/
4 702 aaronmk
    Install: make install
5 3370 aaronmk
        WARNING: This will delete the current public schema of your VegBIEN DB!
6 702 aaronmk
    Uninstall: make uninstall
7 3370 aaronmk
        WARNING: This will delete your entire VegBIEN DB!
8 3374 aaronmk
        This includes all archived imports and staging tables.
9 554 aaronmk
10 3674 aaronmk
Maintenance:
11 6846 aaronmk
    VegCore data dictionary:
12
        Regularly, or whenever the VegCore data dictionary page
13
            (https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCore)
14
            is changed, regenerate mappings/VegCore.csv:
15 6856 aaronmk
            make mappings/VegCore.htm-remake; make mappings/
16 7376 aaronmk
            When moving terms, check that no terms were lost:
17
                di mappings/VegCore.csv|grep ^+|wc -l
18
                di mappings/VegCore.csv|grep ^-|wc -l
19
                Check that the outputted counts are equal
20 6987 aaronmk
            svn ci -m "mappings/VegCore.csv: Regenerated from wiki"
21 3674 aaronmk
    Important: Whenever you install a system update that affects PostgreSQL or
22
        any of its dependencies, such as libc, you should restart the PostgreSQL
23
        server. Otherwise, you may get strange errors like "the database system
24 6820 aaronmk
        is in recovery mode" which go away upon reimport, or you may not be able
25 6821 aaronmk
        to access the database as the postgres superuser. This applies to both
26
        Linux and Mac OS X.
27 3674 aaronmk
28 7287 aaronmk
Single datasource import:
29
    (Re)import and scrub: make inputs/<datasrc>/reimport_scrub
30
    (Re)import only: make inputs/<datasrc>/reimport
31
    (Re)scrub: make inputs/<datasrc>/rescrub
32
    Note that these commands also work if the datasource is not yet imported
33
34
Full database import:
35 4487 aaronmk
    On local machine:
36 7114 aaronmk
        make inputs/upload
37 4487 aaronmk
        make test by_col=1
38 5016 aaronmk
            See note under Testing below
39 4487 aaronmk
    On vegbiendev:
40 7032 aaronmk
    Ensure there are no local modifications: svn st
41 4482 aaronmk
    svn up
42 7114 aaronmk
    For each newly-uploaded datasource above: make inputs/<datasrc>/reinstall
43 6952 aaronmk
    Update the auxiliary schemas: make schemas/reinstall
44
        The public schema will be installed separately by the import process
45 6962 aaronmk
    Delete imports before the last so they won't bloat the full DB backup:
46
        make backups/vegbien.<version>.backup/remove
47 7205 aaronmk
        To keep a previous import other than the public schema:
48
            export dump_opts='--exclude-schema=public --exclude-schema=<version>'
49 7224 aaronmk
    Make sure there is at least 150GB of disk space on /: df -h
50 7300 aaronmk
        The import schema is 100GB, and may use additional space for temp tables
51 6804 aaronmk
        To free up space, remove backups that have been archived on jupiter:
52
            List backups/ to view older backups
53
            Check their MD5 sums using the steps under On jupiter below
54
            Remove these backups
55 6995 aaronmk
    unset version
56 5206 aaronmk
    Start column-based import: . bin/import_all by_col=1
57
        To use row-based import: . bin/import_all
58 4481 aaronmk
        To stop all running imports: . bin/stop_imports
59 5318 aaronmk
        WARNING: Do NOT run import_all in the background, or the jobs it creates
60
            won't be owned by your shell.
61 6797 aaronmk
        Note that import_all will take several hours to import the NCBI backbone
62
            and TNRS names before returning control to the shell.
63 4481 aaronmk
    Wait (overnight) for the import to finish
64 6796 aaronmk
    On local machine: make inputs/download-logs
65 7318 aaronmk
    In PostgreSQL:
66
        Check that the provider_count and source tables contain entries for all
67
            inputs
68
        Check that unscrubbed_taxondetermination_view returns no rows
69 7319 aaronmk
        Check that there are taxondeterminations whose source_id is
70
            source_by_shortname('TNRS')
71 6964 aaronmk
    tail inputs/{.,}*/*/logs/$version.log.sql
72 6799 aaronmk
    In the output, search for "Command exited with non-zero status"
73
    For inputs that have this, fix the associated bug(s)
74
    If many inputs have errors, discard the current (partial) import:
75 6953 aaronmk
        make schemas/$version/uninstall
76 6103 aaronmk
    Otherwise, continue
77 6959 aaronmk
    make schemas/$version/publish
78 7299 aaronmk
    unset version
79 6848 aaronmk
    sudo backups/fix_perms
80 6666 aaronmk
    make backups/upload
81 6719 aaronmk
    On jupiter:
82 6888 aaronmk
        cd /data/dev/aaronmk/bien/backups
83 6719 aaronmk
        For each newly-archived backup:
84 7326 aaronmk
            make -s <backup>.md5/test
85 6719 aaronmk
            Check that "OK" is printed next to the filename
86 6494 aaronmk
    On nimoy:
87
        cd /home/bien/svn/
88
        svn up
89 6993 aaronmk
        export version=<version>
90 6948 aaronmk
        make backups/analytical_aggregate.$version.csv/download
91 7326 aaronmk
        make -s backups/analytical_aggregate.$version.csv.md5/test
92 6723 aaronmk
        Check that "OK" is printed next to the filename
93 6494 aaronmk
        In the bien_web DB:
94 6994 aaronmk
            Create the analytical_aggregate_<version> table using its schema
95 6652 aaronmk
                in schemas/vegbien.my.sql
96 6948 aaronmk
        env table=analytical_aggregate_$version bin/publish_analytical_db \
97
            backups/analytical_aggregate.$version.csv
98 4677 aaronmk
    If desired, record the import times in inputs/import.stats.xls:
99
        Open inputs/import.stats.xls
100 7027 aaronmk
        Insert a copy of the leftmost "By column" column group before it
101 7344 aaronmk
        export version=<version>
102 6996 aaronmk
        bin/import_date inputs/{.,}*/*/logs/$version.log.sql
103 4677 aaronmk
        Update the import date in the upper-right corner
104 6996 aaronmk
        bin/import_times inputs/{.,}*/*/logs/$version.log.sql
105 4677 aaronmk
        Paste the output over the # Rows/Time columns, making sure that the
106
            row counts match up with the previous import's row counts
107
        If the row counts do not match up, insert or reorder rows as needed
108
            until they do
109 4777 aaronmk
        Commit: svn ci -m "inputs/import.stats.xls: Updated import times"
110 7325 aaronmk
    To scrub unscrubbed taxondeterminations: make scrub by_col=1 &
111
        To view progress:
112
            tail -f inputs/.TNRS/public.unscrubbed_taxondetermination_view/logs/$version.log.sql
113 6956 aaronmk
    To remake analytical DB: bin/make_analytical_db &
114 6212 aaronmk
        To view progress:
115
            tail -f inputs/analytical_db/logs/make_analytical_db.log.sql
116 3381 aaronmk
117 3545 aaronmk
Backups:
118 3408 aaronmk
    Archived imports:
119 6942 aaronmk
        Back up: make backups/<version>.backup &
120 6516 aaronmk
            Note: To back up the last import, you must archive it first:
121
                make schemas/rotate
122 7326 aaronmk
        Test: make -s backups/<version>.backup/test &
123 6942 aaronmk
        Restore: make backups/<version>.backup/restore &
124
        Remove: make backups/<version>.backup/remove
125 3701 aaronmk
        Download: make backups/download
126 5801 aaronmk
    TNRS cache:
127
        Back up: make backups/TNRS.backup-remake &
128
        Restore:
129
            yes|make inputs/.TNRS/uninstall
130
            make backups/TNRS.backup/restore &
131
            yes|make schemas/public/reinstall
132
                Must come after TNRS restore to recreate tnrs_input_name view
133 3408 aaronmk
    Full DB:
134 6942 aaronmk
        Back up: make backups/vegbien.<version>.backup &
135 7326 aaronmk
        Test: make -s backups/vegbien.<version>.backup/test &
136 6942 aaronmk
        Restore: make backups/vegbien.<version>.backup/restore &
137 3701 aaronmk
        Download: make backups/download
138 3698 aaronmk
    Import logs:
139
        Download: make inputs/download-logs
140 554 aaronmk
141 1773 aaronmk
Datasource setup:
142 4219 aaronmk
    Add a new datasource: make inputs/<datasrc>/add
143
        <datasrc> may not contain spaces, and should be abbreviated.
144
        If the datasource is a herbarium, <datasrc> should be the herbarium code
145
            as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
146 6366 aaronmk
    For MySQL inputs (exports and live DB connections):
147
        For .sql exports:
148
            Place the original .sql file in _src/ (*not* in _MySQL/)
149
            Create a database for the MySQL export in phpMyAdmin
150
            mysql -p database <inputs/<datasrc>/_src/export.sql
151
        mkdir inputs/<datasrc>/_MySQL/
152
        cp -p lib/MySQL.{data,schema}.sql.make inputs/<datasrc>/_MySQL/
153
        Edit _MySQL/*.make for the DB connection
154
            For a .sql export, use your local MySQL DB
155 6372 aaronmk
        Install the export according to Install the staging tables below
156 4218 aaronmk
    Add input data for each table present in the datasource:
157 6365 aaronmk
        For .sql exports, you must use the name of the table in the DB export
158
        For CSV files, you can use any name. It's recommended to use a table
159
            name from <https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCSV#Suggested-table-names>
160 4264 aaronmk
        Note that if this table will be joined together with another table, its
161
            name must end in ".src"
162 4219 aaronmk
        make inputs/<datasrc>/<table>/add
163 4342 aaronmk
            Important: DO NOT just create an empty directory named <table>!
164
                This command also creates necessary subdirs, such as logs/.
165 6373 aaronmk
        If the table is in a .sql export: make inputs/<datasrc>/<table>/install
166
            Otherwise, place the CSV(s) for the table in
167 6370 aaronmk
            inputs/<datasrc>/<table>/ OR place a query joining other tables
168
            together in inputs/<datasrc>/<table>/create.sql
169 4212 aaronmk
        Important: When exporting relational databases to CSVs, you MUST ensure
170
            that embedded quotes are escaped by doubling them, *not* by
171
            preceding them with a "\" as is the default in phpMyAdmin
172 3612 aaronmk
        If there are multiple part files for a table, and the header is repeated
173
            in each part, make sure each header is EXACTLY the same.
174
             (If the headers are not the same, the CSV concatenation script
175
             assumes the part files don't have individual headers and treats the
176
             subsequent headers as data rows.)
177 4255 aaronmk
        Add <table> to inputs/<datasrc>/import_order.txt before other tables
178 4220 aaronmk
            that depend on it
179 3611 aaronmk
    Install the staging tables:
180 4219 aaronmk
        make inputs/<datasrc>/reinstall quiet=1 &
181
        To view progress: tail -f inputs/<datasrc>/<table>/logs/install.log.sql
182
        View the logs: tail -n +1 inputs/<datasrc>/*/logs/install.log.sql
183 3611 aaronmk
            tail provides a header line with the filename
184
            +1 starts at the first line, to show the whole file
185
        For every file with an error 'column "..." specified more than once':
186 4182 aaronmk
            Add a header override file "+header.<ext>" in <table>/:
187 3611 aaronmk
                Note: The leading "+" should sort it before the flat files.
188
                    "_" unfortunately sorts *after* capital letters in ASCII.
189
                Create a text file containing the header line of the flat files
190
                Add an ! at the beginning of the line
191
                    This signals cat_csv that this is a header override.
192
                For empty names, use their 0-based column # (by convention)
193
                For duplicate names, add a distinguishing suffix
194
                For long names that collided, rename them to <= 63 chars long
195
                Do NOT make readability changes in this step; that is what the
196
                    map spreadsheets (below) are for.
197
                Save
198
        If you made any changes, re-run the install command above
199 6015 aaronmk
    Auto-create the map spreadsheets: make inputs/<datasrc>/
200 3576 aaronmk
    Map each table's columns:
201 4125 aaronmk
        In each <table>/ subdir, for each "via map" map.csv:
202 3576 aaronmk
            Open the map in a spreadsheet editor
203 4125 aaronmk
            Open the "core map" /mappings/Veg+-VegBIEN.csv
204 3576 aaronmk
            In each row of the via map, set the right column to a value from the
205
                left column of the core map
206
            Save
207 4219 aaronmk
        Regenerate the derived maps: make inputs/<datasrc>/
208 3593 aaronmk
    Accept the test cases:
209 4219 aaronmk
        make inputs/<datasrc>/test
210 3593 aaronmk
            When prompted to "Accept new test output", enter y and press ENTER
211 3690 aaronmk
            If you instead get errors, do one of the following for each one:
212
            -   If the error was due to a bug, fix it
213
            -   Add a SQL function that filters or transforms the invalid data
214
            -   Make an empty mapping for the columns that produced the error.
215
                Put something in the Comments column of the map spreadsheet to
216
                prevent the automatic mapper from auto-removing the mapping.
217 3783 aaronmk
            When accepting tests, it's helpful to use WinMerge
218
                (see WinMerge setup below for configuration)
219 4476 aaronmk
        make inputs/<datasrc>/test by_col=1
220
            If you get errors this time, this always indicates a bug, usually in
221 6368 aaronmk
                the VegBIEN unique constraints or column-based import itself
222 5881 aaronmk
    Add newly-created files: make inputs/<datasrc>/add
223 4219 aaronmk
    Commit: svn ci -m "Added inputs/<datasrc>/" inputs/<datasrc>/
224 3585 aaronmk
    Update vegbiendev:
225
        On vegbiendev: svn up
226
        On local machine: make inputs/upload
227 4291 aaronmk
        On vegbiendev:
228
            Follow the steps under Install the staging tables above
229
            make inputs/<datasrc>/test
230 1773 aaronmk
231 6484 aaronmk
Datasource refreshing:
232
    VegBank:
233
        make inputs/VegBank/vegbank.sql-remake
234
        make inputs/VegBank/reinstall quiet=1 &
235
236 702 aaronmk
Schema changes:
237 7347 aaronmk
    When changing the analytical views, run sync_analytical_..._to_view()
238
        to update the corresponding table
239 5227 aaronmk
    Remember to update the following files with any renamings:
240
        schemas/filter_ERD.csv
241
        mappings/VegCore-VegBIEN.csv
242 6058 aaronmk
        mappings/verify.*.sql
243 702 aaronmk
    Regenerate schema from installed DB: make schemas/remake
244 6951 aaronmk
    Reinstall DB from schema: make schemas/public/reinstall schemas/reinstall
245 3370 aaronmk
        WARNING: This will delete the current public schema of your VegBIEN DB!
246 3589 aaronmk
    Reinstall staging tables: . bin/reinstall_all
247 702 aaronmk
    Sync ERD with vegbien.sql schema:
248
        Run make schemas/vegbien.my.sql
249
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
250
        Go to File > Export > Synchronize With SQL CREATE Script...
251
        For Input File, select schemas/vegbien.my.sql
252
        Click Continue
253 6369 aaronmk
        In the changes list, select each table with an arrow next to it
254 702 aaronmk
        Click Update Model
255
        Click Continue
256
        Note: The generated SQL script will be empty because we are syncing in
257
            the opposite direction
258
        Click Execute
259
        Reposition any lines that have been reset
260
        Add any new tables by dragging them from the Catalog in the left sidebar
261
            to the diagram
262
        Remove any deleted tables by right-clicking the table's diagram element,
263
            selecting Delete '<table name>', and clicking Delete
264
        Save
265 1774 aaronmk
        If desired, update the graphical ERD exports (see below)
266
    Update graphical ERD exports:
267 702 aaronmk
        Go to File > Export > Export as PNG...
268 1774 aaronmk
        Select schemas/vegbien.ERD.png and click Save
269 702 aaronmk
        Go to File > Export > Export as SVG...
270 1774 aaronmk
        Select schemas/vegbien.ERD.svg and click Save
271 702 aaronmk
        Go to File > Export > Export as Single Page PDF...
272 4087 aaronmk
        Select schemas/vegbien.ERD.1_pg.pdf and click Save
273 1774 aaronmk
        Go to File > Print...
274
        In the lower left corner, click PDF > Save as PDF...
275
        Set the Title and Author to ""
276 4087 aaronmk
        Select schemas/vegbien.ERD.pdf and click Save
277 7003 aaronmk
        Commit: svn ci -m "schemas/vegbien.ERD.mwb: Regenerated exports"
278 5226 aaronmk
    Refactoring tips:
279
        To rename a table:
280
            In vegbien.sql, do the following:
281
                Replace regexp (?<=_|\b)<old>(?=_|\b) with <new>
282
                    This is necessary because the table name is *everywhere*
283
                Search for <new>
284
                Manually change back any replacements inside comments
285
        To rename a column:
286
            Rename the column: ALTER TABLE <table> RENAME <old> TO <new>;
287
            Recreate any foreign key for the column, removing CONSTRAINT <name>
288
                This resets the foreign key name using the new column name
289 6320 aaronmk
    Creating a poster of the ERD:
290 6326 aaronmk
        Determine the poster size:
291 6320 aaronmk
            Measure the line height (from the bottom of one line to the bottom
292
                of another): 16.3cm/24 lines = 0.679cm
293
            Measure the height of the ERD: 35.4cm*2 = 70.8cm
294
            Zoom in as far as possible
295
            Measure the height of a capital letter: 3.5mm
296
            Measure the line height: 8.5mm
297
            Calculate the text's fraction of the line height: 3.5mm/8.5mm = 0.41
298
            Calculate the text height: 0.679cm*0.41 = 0.28cm
299
            Calculate the text height's fraction of the ERD height:
300
                0.28cm/70.8cm = 0.0040
301
            Measure the text height on the *VegBank* ERD poster: 5.5mm = 0.55cm
302
            Calculate the VegBIEN poster height to make the text the same size:
303
                0.55cm/0.0040 = 137.5cm H; *1in/2.54cm = 54.1in H
304
            The ERD aspect ratio is 11 in W x (2*8.5in H) = 11x17 portrait
305
            Calculate the VegBIEN poster width: 54.1in H*11W/17H = 35.0in W
306
            The minimum VegBIEN poster size is 35x54in portrait
307 6327 aaronmk
        Determine the cost:
308
            The FedEx Kinkos near NCEAS (1030 State St, Santa Barbara, CA 93101)
309
                charges the following for posters:
310
                base: $7.25/sq ft
311
                lamination: $3/sq ft
312
                mounting on a board: $8/sq ft
313 203 aaronmk
314 1459 aaronmk
Testing:
315 7090 aaronmk
    On a development machine, you should put the following in your .profile:
316 7122 aaronmk
        export log= n=2
317 1459 aaronmk
    Mapping process: make test
318 4292 aaronmk
        Including column-based import: make test by_col=1
319 4985 aaronmk
            If the row-based and column-based imports produce different inserted
320
            row counts, this usually means that a table is underconstrained
321
            (the unique indexes don't cover all possible rows).
322
            This can occur if you didn't use COALESCE(field, null_value) around
323
            a nullable field in a unique index. See sql_gen.null_sentinels for
324
            the appropriate null value to use.
325 1459 aaronmk
    Map spreadsheet generation: make remake
326 1744 aaronmk
    Missing mappings: make missing_mappings
327 1459 aaronmk
    Everything (for most complete coverage): make test-all
328 702 aaronmk
329 7183 aaronmk
Debugging:
330
    "Binary chop" debugging:
331
        (This is primarily useful for regressions that occurred in a previous
332
        revision, which was committed without running all the tests)
333
        svn up -r <rev>; make inputs/.TNRS/reinstall; make schemas/public/reinstall; make <failed-test>.xml
334
335 3783 aaronmk
WinMerge setup:
336
    Install WinMerge from <http://winmerge.org/>
337 3785 aaronmk
    Open WinMerge
338
    Go to Edit > Options and click Compare in the left sidebar
339 3783 aaronmk
    Enable "Moved block detection", as described at
340
        <http://manual.winmerge.org/Configuration.html#d0e5892>.
341 3784 aaronmk
    Set Whitespace to Ignore change, as described at
342
        <http://manual.winmerge.org/Configuration.html#d0e5758>.
343 3783 aaronmk
344 3133 aaronmk
Documentation:
345
    To generate a Redmine-formatted list of steps for column-based import:
346 7178 aaronmk
        make schemas/public/reinstall
347 6291 aaronmk
        make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
348 5210 aaronmk
    To import and scrub just the test taxonomic names:
349 5415 aaronmk
        inputs/test_taxonomic_names/test_scrub
350 3133 aaronmk
351 702 aaronmk
General:
352
    To see a program's description, read its top-of-file comment
353
    To see a program's usage, run it without arguments
354 3389 aaronmk
    To remake a directory: make <dir>/remake
355
    To remake a file: make <file>-remake