Project

General

Profile

1
Installation:
2
	Check out svn: svn co https://code.nceas.ucsb.edu/code/projects/bien
3
	cd bien/
4
	Install: make install
5
		**WARNING**: This will delete the public schema of your VegBIEN DB!
6
	Uninstall: make uninstall
7
		**WARNING**: This will delete your entire VegBIEN DB!
8
		This includes all archived imports and staging tables.
9

    
10
Connecting to vegbiendev:
11
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
12
	cd /home/bien/svn # should happen automatically at login
13

    
14
Notes on running programs:
15
	**WARNING**: always start with a clean shell, to avoid spurious bugs. the
16
		shell should not have changes to the env vars. (there have been bugs
17
		that went away after closing and reopening the terminal window.) note
18
		that running `exec bash` is not sufficient to *reset* the env vars.
19

    
20
Notes on editing files:
21
	**WARNING**: shell scripts should always be read-only, so that editing them
22
		while an import is in progress will not crash the import (see
23
		http://vegpath.org/links/#**%20modifying%20a%20running%20shell%20script)
24

    
25
Single datasource import:
26
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
27
	(Re)import and scrub: make inputs/<datasrc>/reimport_scrub by_col=1 &
28
	(Re)import only: make inputs/<datasrc>/reimport by_col=1 &
29
	Note that these commands also work if the datasource is not yet imported
30
	Remake analytical DB: see Full database import > To remake analytical DB
31

    
32
Full database import:
33
	**WARNING**: You must perform *every single* step listed below, to avoid
34
		breaking column-based import
35
	**WARNING**: always start with a clean shell, as described above under
36
		"Notes on running programs"
37
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
38
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk, using jupiter instead
39
	ssh aaronmk@jupiter.nceas.ucsb.edu
40
		svn up --force
41
	On local machine:
42
		do steps under Maintenance > "to synchronize vegbiendev, jupiter, and
43
			your local machine"
44
		make inputs/upload
45
		make inputs/upload live=1
46
		make test by_col=1 # runtime: 20 min ("4m46.108s" + ("21:50:43" - "21:37:09")) @starscream
47
			if you encounter errors, they are most likely related to the
48
				PostgreSQL error parsing in /lib/sql.py parse_exception()
49
			See note under Testing below
50
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
51
	Ensure there are no local modifications: svn st
52
	svn up
53
	make inputs/download
54
	make inputs/download live=1
55
	For each newly-uploaded datasource above: make inputs/<datasrc>/reinstall
56
	Update the auxiliary schemas: make schemas/reinstall
57
		**WARNING**: requires sudo access!
58
		The public schema will be installed separately by the import process
59
	Delete imports before the last so they won't bloat the full DB backup:
60
		make backups/vegbien.<version>.backup/remove
61
		To keep a previous import other than the public schema:
62
			export dump_opts='--exclude-schema=public --exclude-schema=<version>'
63
	Make sure there is at least 300GB of disk space on /: df -h
64
		The import schema is 230GB, and may use additional space for temp tables
65
		To free up space, remove backups that have been archived on jupiter:
66
			List backups/ to view older backups
67
			Check their MD5 sums using the steps under On jupiter below
68
			Remove these backups
69
	screen
70
	Press ENTER
71
	unset TMOUT # TMOUT causes screen to exit even with background processes
72
	set -o ignoreeof #prevent Ctrl+D from exiting `screen` to keep attached jobs
73
	unset version
74
	Start column-based import: . bin/import_all
75
		To use row-based import: . bin/import_all by_col=
76
		To stop all running imports: . bin/stop_imports
77
		**WARNING**: Do NOT run import_all in the background, or the jobs it
78
			creates won't be owned by your shell.
79
		Note that import_all will take up to an hour to import the NCBI backbone
80
			and other metadata before returning control to the shell.
81
		To view progress:
82
			tail inputs/{.,}*/*/logs/$version.log.sql
83
	Wait (4 days) for the import to finish
84
	To recover from a closed terminal window: screen -r
85
	To restart an aborted import for a specific table:
86
		export version=<version>
87
		(set -o errexit; make inputs/<datasrc>/<table>/import_scrub by_col=1 continue=1; make inputs/<datasrc>/publish) &
88
		bin/after_import $! & # $! can also be obtained from `jobs -l`
89
	Get $version: echo $version
90
	Set $version in all vegbiendev terminals: export version=<version>
91
	When there are no more running jobs, exit the screen
92
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
93
		Upload logs: make inputs/upload live=1
94
	On local machine: make inputs/download-logs live=1
95
	In PostgreSQL:
96
		Go to wiki.vegpath.org/VegBIEN_contents
97
		Get the # observations
98
		Get the # datasources
99
		Get the # datasources with observations
100
		in the r# schema:
101
		Check that analytical_stem contains [# observations] rows
102
		Check that source contains [# datasources] rows up through XAL. If this
103
			is not the case, manually check the entries in source against the
104
			datasources list on the wiki page (some datasources may be near the
105
			end depending on import order).
106
		Check that provider_count contains [# datasources with observations]
107
			rows with dataset="(total)" (at the top when the table is unsorted)
108
	Check that TNRS ran successfully:
109
		tail -100 inputs/.TNRS/tnrs/logs/tnrs.make.log.sql
110
		If the log ends in an AssertionError
111
			"assert sql.table_col_names(db, table) == header":
112
			Figure out which TNRS CSV columns have changed
113
			On local machine:
114
				Make the changes in the DB's TNRS and public schemas
115
				rm=1 inputs/.TNRS/schema.sql.run export_
116
				make schemas/remake
117
				inputs/test_taxonomic_names/test_scrub # re-run TNRS
118
				rm=1 inputs/.TNRS/data.sql.run export_
119
				Commit
120
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
121
				If dropping a column, save the dependent views
122
				Make the same changes in the live TNRS.tnrs table on vegbiendev
123
				If dropping a column, recreate the dependent views
124
				Restart the TNRS client: make scrub by_col=1 &
125
	tail inputs/{.,}*/*/logs/$version.log.sql
126
	In the output, search for "Command exited with non-zero status"
127
	For inputs that have this, fix the associated bug(s)
128
	If many inputs have errors, discard the current (partial) import:
129
		make schemas/$version/uninstall
130
	Otherwise, continue
131
	Publish the new import:
132
		**WARNING**: Before proceeding, be sure you have done *every single*
133
			verification step listed above. Otherwise, a previous valid import
134
			could incorrectly be overwritten with a broken one.
135
		make schemas/$version/publish # runtime: 1 min ("real 1m10.451s")
136
	unset version
137
	make backups/upload live=1
138
	on local machine:
139
		make backups/vegbien.$version.backup/download live=1
140
			# download backup to local machine
141
	ssh aaronmk@jupiter.nceas.ucsb.edu
142
		cd /data/dev/aaronmk/bien/backups
143
		For each newly-archived backup:
144
			make -s <backup>.md5/test
145
			Check that "OK" is printed next to the filename
146
	If desired, record the import times in inputs/import.stats.xls:
147
		On local machine:
148
		Open inputs/import.stats.xls
149
		If the rightmost import is within 5 columns of column IV:
150
			Copy the current tab to <leftmost-date>~<rightmost-date>
151
			Remove the previous imports from the current tab because they are
152
				now in the copied tab instead
153
		Insert a copy of the leftmost "By column" column group before it
154
		export version=<version>
155
		bin/import_date inputs/{.,}*/*/logs/$version.log.sql
156
		Update the import date in the upper-right corner
157
		bin/import_times inputs/{.,}*/*/logs/$version.log.sql
158
		Paste the output over the # Rows/Time columns, making sure that the
159
			row counts match up with the previous import's row counts
160
		If the row counts do not match up, insert or reorder rows as needed
161
			until they do. Get the datasource names from the log file footers:
162
			tail inputs/{.,}*/*/logs/$version.log.sql
163
		Commit: svn ci -m 'inputs/import.stats.xls: updated import times'
164
	Running individual steps separately:
165
	To run TNRS:
166
		To use an import other than public: export version=<version>
167
		make scrub &
168
		To view progress:
169
			tail -100 inputs/.TNRS/tnrs/logs/tnrs.make.log.sql
170
	To remake analytical DB:
171
		To use an import other than public: export version=<version>
172
		bin/make_analytical_db & # runtime: 13 h ("12:43:57elapsed")
173
		To view progress:
174
			tail -150 inputs/analytical_db/logs/make_analytical_db.log.sql
175
	To back up DB (staging tables and last import):
176
		To use an import *other than public*: export version=<version>
177
		make backups/TNRS.backup-remake &
178
		dump_opts=--exclude-schema=public make backups/vegbien.$version.backup/test &
179
			If after renaming to public, instead set dump_opts='' and replace
180
			$version with the appropriate revision
181
		make backups/upload live=1
182

    
183
Datasource setup:
184
	On local machine:
185
	Example steps for a datasource: wiki.vegpath.org/Import_process_for_Madidi
186
	umask ug=rwx,o= # prevent files from becoming web-accessible
187
	Add a new datasource: make inputs/<datasrc>/add
188
		<datasrc> may not contain spaces, and should be abbreviated.
189
		If the datasource is a herbarium, <datasrc> should be the herbarium code
190
			as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
191
	For a new-style datasource (one containing a ./run runscript):
192
		"cp" -f inputs/.NCBI/{Makefile,run,table.run} inputs/<datasrc>/
193
	For MySQL inputs (exports and live DB connections):
194
		For .sql exports:
195
			Place the original .sql file in _src/ (*not* in _MySQL/)
196
			Follow the steps starting with Install the staging tables below.
197
				This is for an initial sync to get the file onto vegbiendev.
198
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
199
				Create a database for the MySQL export in phpMyAdmin
200
				Give the bien user all database-specific privileges *except*
201
					UPDATE, DELETE, ALTER, DROP. This prevents bugs in the
202
					import scripts from accidentally deleting data.
203
				bin/mysql_bien database <inputs/<datasrc>/_src/export.sql &
204
		mkdir inputs/<datasrc>/_MySQL/
205
		cp -p lib/MySQL.{data,schema}.sql.make inputs/<datasrc>/_MySQL/
206
		Edit _MySQL/*.make for the DB connection
207
			For a .sql export, use server=vegbiendev and --user=bien
208
		Skip the Add input data for each table section
209
	For MS Access databases:
210
		Place the .mdb or .accdb file in _src/
211
		Download and install Access To PostgreSQL from
212
			http://www.bullzip.com/download.php
213
		Use Access To PostgreSQL to export the database:
214
			Export just the tables/indexes to inputs/<datasrc>/<file>.schema.sql
215
			Export just the data to inputs/<datasrc>/<file>.data.sql
216
		In <file>.schema.sql, make the following changes:
217
			Replace text "BOOLEAN" with "/*BOOLEAN*/INTEGER"
218
			Replace text "DOUBLE PRECISION NULL" with "DOUBLE PRECISION"
219
		Skip the Add input data for each table section
220
	Add input data for each table present in the datasource:
221
		For .sql exports, you must use the name of the table in the DB export
222
		For CSV files, you can use any name. It's recommended to use a table
223
			name from <https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCSV#Suggested-table-names>
224
		Note that if this table will be joined together with another table, its
225
			name must end in ".src"
226
		make inputs/<datasrc>/<table>/add
227
			Important: DO NOT just create an empty directory named <table>!
228
				This command also creates necessary subdirs, such as logs/.
229
		If the table is in a .sql export: make inputs/<datasrc>/<table>/install
230
			Otherwise, place the CSV(s) for the table in
231
			inputs/<datasrc>/<table>/ OR place a query joining other tables
232
			together in inputs/<datasrc>/<table>/create.sql
233
		Important: When exporting relational databases to CSVs, you MUST ensure
234
			that embedded quotes are escaped by doubling them, *not* by
235
			preceding them with a "\" as is the default in phpMyAdmin
236
		If there are multiple part files for a table, and the header is repeated
237
			in each part, make sure each header is EXACTLY the same.
238
			(If the headers are not the same, the CSV concatenation script
239
			assumes the part files don't have individual headers and treats the
240
			subsequent headers as data rows.)
241
		Add <table> to inputs/<datasrc>/import_order.txt before other tables
242
			that depend on it
243
		For a new-style datasource:
244
			"cp" -f inputs/.NCBI/nodes/run inputs/<datasrc>/<table>/
245
			inputs/<datasrc>/<table>/run
246
	Install the staging tables:
247
		make inputs/<datasrc>/reinstall quiet=1 &
248
		For a MySQL .sql export:
249
			At prompt "[you]@vegbiendev's password:", enter your password
250
			At prompt "Enter password:", enter the value in config/bien_password
251
		To view progress: tail -f inputs/<datasrc>/<table>/logs/install.log.sql
252
		View the logs: tail -n +1 inputs/<datasrc>/*/logs/install.log.sql
253
			tail provides a header line with the filename
254
			+1 starts at the first line, to show the whole file
255
		For every file with an error 'column "..." specified more than once':
256
			Add a header override file "+header.<ext>" in <table>/:
257
				Note: The leading "+" should sort it before the flat files.
258
					"_" unfortunately sorts *after* capital letters in ASCII.
259
				Create a text file containing the header line of the flat files
260
				Add an ! at the beginning of the line
261
					This signals cat_csv that this is a header override.
262
				For empty names, use their 0-based column # (by convention)
263
				For duplicate names, add a distinguishing suffix
264
				For long names that collided, rename them to <= 63 chars long
265
				Do NOT make readability changes in this step; that is what the
266
					map spreadsheets (below) are for.
267
				Save
268
		If you made any changes, re-run the install command above
269
	Auto-create the map spreadsheets: make inputs/<datasrc>/
270
	Map each table's columns:
271
		In each <table>/ subdir, for each "via map" map.csv:
272
			Open the map in a spreadsheet editor
273
			Open the "core map" /mappings/Veg+-VegBIEN.csv
274
			In each row of the via map, set the right column to a value from the
275
				left column of the core map
276
			Save
277
		Regenerate the derived maps: make inputs/<datasrc>/
278
	Accept the test cases:
279
		For a new-style datasource:
280
			inputs/<datasrc>/run
281
			svn di inputs/<datasrc>/*/test.xml.ref
282
			If you get errors, follow the steps for old-style datasources below
283
		For an old-style datasource:
284
			make inputs/<datasrc>/test
285
			When prompted to "Accept new test output", enter y and press ENTER
286
			If you instead get errors, do one of the following for each one:
287
			-	If the error was due to a bug, fix it
288
			-	Add a SQL function that filters or transforms the invalid data
289
			-	Make an empty mapping for the columns that produced the error.
290
				Put something in the Comments column of the map spreadsheet to
291
				prevent the automatic mapper from auto-removing the mapping.
292
			When accepting tests, it's helpful to use WinMerge
293
				(see WinMerge setup below for configuration)
294
		make inputs/<datasrc>/test by_col=1
295
			If you get errors this time, this always indicates a bug, usually in
296
				the VegBIEN unique constraints or column-based import itself
297
	Add newly-created files: make inputs/<datasrc>/add
298
	Commit: svn ci -m "Added inputs/<datasrc>/" inputs/<datasrc>/
299
	Update vegbiendev:
300
		ssh aaronmk@jupiter.nceas.ucsb.edu
301
			svn up
302
		On local machine:
303
			./fix_perms
304
			make inputs/upload
305
			make inputs/upload live=1
306
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
307
			svn up
308
			make inputs/download
309
			make inputs/download live=1
310
			Follow the steps under Install the staging tables above
311

    
312
Maintenance:
313
	on a live machine, you should put the following in your .profile:
314
--
315
# make svn files web-accessible. this does not affect unversioned files, because
316
# these get the right permissions on the local machine instead.
317
umask ug=rwx,o=rx
318

    
319
unset TMOUT # TMOUT causes screen to exit even with background processes
320
--
321
	if http://vegbiendev.nceas.ucsb.edu/phppgadmin/ goes down:
322
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
323
			make phppgadmin-Linux
324
	to synchronize vegbiendev, jupiter, and your local machine:
325
		**WARNING**: pay careful attention to all files that will be deleted or
326
			overwritten!
327
		install put if needed:
328
			download https://uutils.googlecode.com/svn/trunk/bin/put to ~/bin/ and `chmod +x` it
329
		when changes are made on vegbiendev:
330
			on all machines: ./fix_perms
331
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
332
				upload:
333
				overwrite=1 bin/sync_upload --size-only
334
					then rerun with l=1 ...
335
			on your machine:
336
				download:
337
				overwrite=1 swap=1 src=. dest='aaronmk@jupiter.nceas.ucsb.edu:~/bien' put --exclude=.svn inputs/VegBIEN/TWiki
338
					then rerun with l=1 ...
339
				overwrite=1 swap=1 bin/sync_upload --size-only
340
					then rerun with l=1 ...
341
				make backups/TNRS.backup/download live=1
342
				overwrite=1 sync_remote_url=~/Dropbox/svn/ bin/sync_upload --existing --size-only # just update mtimes/perms
343
					then rerun with l=1 ...
344
	to synchronize a Mac's settings with my testing machine's:
345
		download:
346
			**WARNING**: this will overwrite all your user's settings!
347
			on your machine:
348
			overwrite=1 swap=1 sync_local_dir=~/Library/ sync_remote_subdir=Library/ bin/sync_upload --exclude="/Saved Application State"
349
				then rerun with l=1 ...
350
		upload:
351
			do step when changes are made on vegbiendev > on your machine, download
352
			ssh aaronmk@jupiter.nceas.ucsb.edu
353
				(cd ~/Dropbox/svn/; up)
354
			on your machine:
355
				rm ~/'Library/Thunderbird/Profiles/9oo8rcyn.default/ImapMail/imap.googlemail.com/[Gmail].sbd/Spam'
356
					# remove the downloaded Spam folder, because spam e-mails often contain viruses that would trigger clamscan
357
				overwrite=1 del= sync_local_dir=~/Dropbox/svn/ sync_remote_subdir=Dropbox/svn/ bin/sync_upload --size-only # just update mtimes
358
					then rerun with l=1 ...
359
				overwrite=1      sync_local_dir=~              sync_remote_subdir=             bin/sync_upload --exclude="/Library/Saved Application State" --exclude="/.Trash" --exclude="/bin" --exclude="/bin/pg_ctl" --exclude="/bin/unzip" --exclude="/Dropbox/home" --exclude="/.profile" --exclude="/.shrc" --exclude="/.bashrc"
360
					then rerun with l=1 ...
361
				overwrite=1      sync_local_dir=~              sync_remote_url=~/Dropbox/home  bin/sync_upload --exclude="/Library/Saved Application State" --exclude="/.Trash" --exclude="/.dropbox" --exclude="/Documents/BIEN" --exclude="/Dropbox" --exclude="/software" --exclude="/VirtualBox VMs/**.sav" --exclude="/VirtualBox VMs/**.vdi" --exclude="/VirtualBox VMs/**.vmdk"
362
					then rerun with l=1 ...
363
		upload just the VirtualBox VMs:
364
			on your machine:
365
				overwrite=1      sync_local_dir=~              sync_remote_subdir=             bin/sync_upload ~/"VirtualBox VMs/**"
366
					then rerun with l=1 ...
367
	to backup files not in Time Machine:
368
		On local machine:
369
		overwrite=1 src=/ dest=/Volumes/Time\ Machine\ Backups/ sudo -E put Library/PostgreSQL/9.3/data/
370
			then rerun with l=1 ...
371
		pg_ctl. stop # stop the PostgreSQL server
372
		overwrite=1 src=/ dest=/Volumes/Time\ Machine\ Backups/ sudo -E put Library/PostgreSQL/9.3/data/
373
			then rerun with l=1 ...
374
		pg_ctl. start # start the PostgreSQL server
375
	to backup e-mails:
376
		on local machine:
377
		/Applications/gmvault-v1.8.1-beta/bin/gmvault sync --multiple-db-owner --type quick aaronmk.nceas@gmail.com
378
		/Applications/gmvault-v1.8.1-beta/bin/gmvault sync --multiple-db-owner --type quick aaronmk@nceas.ucsb.edu
379
		open Thunderbird
380
		click the All Mail folder for each account and wait for it to download the e-mails in it
381
	to back up the version history:
382
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
383
		svnsync sync file:///home/aaronmk/Dropbox/docs/BIEN/svn_repo/ # initial runtime: 1.5 h ("08:21:38" - "06:45:26") @vegbiendev
384
		(cd ~/Dropbox/docs/BIEN/git/; git svn fetch)
385
		overwrite=1        src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:~' put Dropbox/docs/BIEN/svn_repo/ # runtime: 1 min ("1:05.08")
386
			then rerun with l=1 ...
387
		overwrite=1        src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:~' put Dropbox/docs/BIEN/git/
388
			then rerun with l=1 ...
389
		on local machine:
390
		overwrite=1 swap=1 src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:~' put Dropbox/docs/BIEN/svn_repo/ # runtime: 30 s ("36.19")
391
			then rerun with l=1 ...
392
		overwrite=1 swap=1 src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:~' put Dropbox/docs/BIEN/git/
393
			then rerun with l=1 ...
394
	VegCore data dictionary:
395
		Regularly, or whenever the VegCore data dictionary page
396
			(https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCore)
397
			is changed, regenerate mappings/VegCore.csv:
398
			On local machine:
399
			make mappings/VegCore.htm-remake; make mappings/
400
			apply new data dict mappings to datasource mappings/staging tables:
401
				inputs/run postprocess # runtime: 30 min ("05:28:31" - "05:00:44") @starscream
402
				yes|make inputs/{NVS,SALVIAS,TEAM}/test # old-style import
403
			svn di mappings/VegCore.tables.redmine
404
			If there are changes, update the data dictionary's Tables section
405
			When moving terms, check that no terms were lost: svn di
406
			svn ci -m 'mappings/VegCore.htm: regenerated from wiki'
407
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
408
				perform the steps under "apply new data dict mappings to
409
					datasource mappings/staging tables" above
410
	Important: Whenever you install a system update that affects PostgreSQL or
411
		any of its dependencies, such as libc, you should restart the PostgreSQL
412
		server. Otherwise, you may get strange errors like "the database system
413
		is in recovery mode" which go away upon reimport, or you may not be able
414
		to access the database as the postgres superuser. This applies to both
415
		Linux and Mac OS X.
416

    
417
Backups:
418
	Archived imports:
419
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
420
		Back up: make backups/<version>.backup &
421
			Note: To back up the last import, you must archive it first:
422
				make schemas/rotate
423
		Test: make -s backups/<version>.backup/test &
424
		Restore: make backups/<version>.backup/restore &
425
		Remove: make backups/<version>.backup/remove
426
		Download: make backups/<version>.backup/download
427
	TNRS cache:
428
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
429
		Back up: make backups/TNRS.backup-remake &
430
			runtime: 3 min ("real 2m48.859s")
431
		Restore:
432
			yes|make inputs/.TNRS/uninstall
433
			make backups/TNRS.backup/restore &
434
				runtime: 5.5 min ("real 5m35.829s")
435
			yes|make schemas/public/reinstall
436
				Must come after TNRS restore to recreate tnrs_input_name view
437
	Full DB:
438
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
439
		Back up: make backups/vegbien.<version>.backup &
440
		Test: make -s backups/vegbien.<version>.backup/test &
441
		Restore: make backups/vegbien.<version>.backup/restore &
442
		Download: make backups/vegbien.<version>.backup/download
443
	Import logs:
444
		On local machine:
445
		Download: make inputs/download-logs live=1
446

    
447
Datasource refreshing:
448
	VegBank:
449
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
450
		make inputs/VegBank/vegbank.sql-remake
451
		make inputs/VegBank/reinstall quiet=1 &
452

    
453
Schema changes:
454
	On local machine:
455
	When changing the analytical views, run sync_analytical_..._to_view()
456
		to update the corresponding table
457
	Remember to update the following files with any renamings:
458
		schemas/filter_ERD.csv
459
		mappings/VegCore-VegBIEN.csv
460
		mappings/verify.*.sql
461
	Regenerate schema from installed DB: make schemas/remake
462
	Reinstall DB from schema: make schemas/public/reinstall schemas/reinstall
463
		**WARNING**: This will delete the public schema of your VegBIEN DB!
464
	If needed, reinstall staging tables:
465
		On local machine:
466
			sudo -E -u postgres psql <<<'ALTER DATABASE vegbien RENAME TO vegbien_prev'
467
			make db
468
			. bin/reinstall_all
469
			Fix any bugs and retry until no errors
470
			make schemas/public/install
471
				This must be run *after* the datasources are installed, because
472
				views in public depend on some of the datasources
473
			sudo -E -u postgres psql <<<'DROP DATABASE vegbien_prev'
474
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
475
			repeat the above steps
476
			**WARNING**: Do not run this until reinstall_all runs successfully
477
			on the local machine, or the live DB may be unrestorable!
478
	Sync ERD with vegbien.sql schema:
479
		Run make schemas/vegbien.my.sql
480
		Open schemas/vegbien.ERD.mwb in MySQLWorkbench
481
		Go to File > Export > Synchronize With SQL CREATE Script...
482
		For Input File, select schemas/vegbien.my.sql
483
		Click Continue
484
		In the changes list, select each table with an arrow next to it
485
		Click Update Model
486
		Click Continue
487
		Note: The generated SQL script will be empty because we are syncing in
488
			the opposite direction
489
		Click Execute
490
		Reposition any lines that have been reset
491
		Add any new tables by dragging them from the Catalog in the left sidebar
492
			to the diagram
493
		Remove any deleted tables by right-clicking the table's diagram element,
494
			selecting Delete '<table name>', and clicking Delete
495
		Save
496
		If desired, update the graphical ERD exports (see below)
497
	Update graphical ERD exports:
498
		Go to File > Export > Export as PNG...
499
		Select schemas/vegbien.ERD.png and click Save
500
		Go to File > Export > Export as SVG...
501
		Select schemas/vegbien.ERD.svg and click Save
502
		Go to File > Export > Export as Single Page PDF...
503
		Select schemas/vegbien.ERD.1_pg.pdf and click Save
504
		Go to File > Print...
505
		In the lower left corner, click PDF > Save as PDF...
506
		Set the Title and Author to ""
507
		Select schemas/vegbien.ERD.pdf and click Save
508
		Commit: svn ci -m "schemas/vegbien.ERD.mwb: Regenerated exports"
509
	Refactoring tips:
510
		To rename a table:
511
			In vegbien.sql, do the following:
512
				Replace regexp (?<=_|\b)<old>(?=_|\b) with <new>
513
					This is necessary because the table name is *everywhere*
514
				Search for <new>
515
				Manually change back any replacements inside comments
516
		To rename a column:
517
			Rename the column: ALTER TABLE <table> RENAME <old> TO <new>;
518
			Recreate any foreign key for the column, removing CONSTRAINT <name>
519
				This resets the foreign key name using the new column name
520
	Creating a poster of the ERD:
521
		Determine the poster size:
522
			Measure the line height (from the bottom of one line to the bottom
523
				of another): 16.3cm/24 lines = 0.679cm
524
			Measure the height of the ERD: 35.4cm*2 = 70.8cm
525
			Zoom in as far as possible
526
			Measure the height of a capital letter: 3.5mm
527
			Measure the line height: 8.5mm
528
			Calculate the text's fraction of the line height: 3.5mm/8.5mm = 0.41
529
			Calculate the text height: 0.679cm*0.41 = 0.28cm
530
			Calculate the text height's fraction of the ERD height:
531
				0.28cm/70.8cm = 0.0040
532
			Measure the text height on the *VegBank* ERD poster: 5.5mm = 0.55cm
533
			Calculate the VegBIEN poster height to make the text the same size:
534
				0.55cm/0.0040 = 137.5cm H; *1in/2.54cm = 54.1in H
535
			The ERD aspect ratio is 11 in W x (2*8.5in H) = 11x17 portrait
536
			Calculate the VegBIEN poster width: 54.1in H*11W/17H = 35.0in W
537
			The minimum VegBIEN poster size is 35x54in portrait
538
		Determine the cost:
539
			The FedEx Kinkos near NCEAS (1030 State St, Santa Barbara, CA 93101)
540
				charges the following for posters:
541
				base: $7.25/sq ft
542
				lamination: $3/sq ft
543
				mounting on a board: $8/sq ft
544

    
545
Testing:
546
	On a development machine, you should put the following in your .profile:
547
		umask ug=rwx,o= # prevent files from becoming web-accessible
548
		export log= n=2
549
	For development machine specs, see /planning/resources/dev_machine.specs/
550
	On local machine:
551
	Mapping process: make test
552
		Including column-based import: make test by_col=1
553
			If the row-based and column-based imports produce different inserted
554
			row counts, this usually means that a table is underconstrained
555
			(the unique indexes don't cover all possible rows).
556
			This can occur if you didn't use COALESCE(field, null_value) around
557
			a nullable field in a unique index. See sql_gen.null_sentinels for
558
			the appropriate null value to use.
559
	Map spreadsheet generation: make remake
560
	Missing mappings: make missing_mappings
561
	Everything (for most complete coverage): make test-all
562

    
563
Debugging:
564
	"Binary chop" debugging:
565
		(This is primarily useful for regressions that occurred in a previous
566
		revision, which was committed without running all the tests)
567
		svn up -r <rev>; make inputs/.TNRS/reinstall; make schemas/public/reinstall; make <failed-test>.xml
568
	.htaccess:
569
		mod_rewrite:
570
			**IMPORTANT**: whenever you change the DirectorySlash setting for a
571
				directory, you *must* clear your browser's cache to ensure that
572
				a cached redirect is not used. this is because RewriteRule
573
				redirects are (by default) temporary, but DirectorySlash
574
				redirects are permanent.
575
				for Firefox:
576
					press Cmd+Shift+Delete
577
					check only Cache
578
					press Enter or click Clear Now
579

    
580
WinMerge setup:
581
	In a Windows VM:
582
	Install WinMerge from <http://winmerge.org/>
583
	Open WinMerge
584
	Go to Edit > Options and click Compare in the left sidebar
585
	Enable "Moved block detection", as described at
586
		<http://manual.winmerge.org/Configuration.html#d0e5892>.
587
	Set Whitespace to Ignore change, as described at
588
		<http://manual.winmerge.org/Configuration.html#d0e5758>.
589

    
590
Documentation:
591
	To generate a Redmine-formatted list of steps for column-based import:
592
		On local machine:
593
		make schemas/public/reinstall
594
		make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
595
	To import and scrub just the test taxonomic names:
596
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
597
		inputs/test_taxonomic_names/test_scrub
598

    
599
General:
600
	To see a program's description, read its top-of-file comment
601
	To see a program's usage, run it without arguments
602
	To remake a directory: make <dir>/remake
603
	To remake a file: make <file>-remake
(6-6/11)