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

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

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

    
315
unset TMOUT # TMOUT causes screen to exit even with background processes
316
--
317
	if http://vegbiendev.nceas.ucsb.edu/phppgadmin/ goes down:
318
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
319
			make phppgadmin-Linux
320
	to synchronize vegbiendev, jupiter, and your local machine:
321
		**WARNING**: pay careful attention to all files that will be deleted or
322
			overwritten!
323
		install put if needed:
324
			download https://uutils.googlecode.com/svn/trunk/bin/put to ~/bin/ and `chmod +x` it
325
		when changes are made on vegbiendev:
326
			avoid extraneous diffs when rsyncing:
327
				on all machines:
328
				up
329
				./fix_perms
330
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
331
				upload:
332
				overwrite=1 bin/sync_upload --size-only
333
					then rerun with l=1 ...
334
			on your machine:
335
				download:
336
				overwrite=1 swap=1 src=. dest='aaronmk@jupiter.nceas.ucsb.edu:~/bien' put --exclude=.svn inputs/VegBIEN/TWiki
337
					then rerun with l=1 ...
338
				swap=1 bin/sync_upload backups/TNRS.backup
339
					then rerun with l=1 ...
340
				overwrite=1 swap=1 bin/sync_upload --size-only
341
					then rerun with l=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 back up e-mails:
345
		on local machine:
346
		/Applications/gmvault-v1.8.1-beta/bin/gmvault sync --multiple-db-owner --type quick aaronmk.nceas@gmail.com
347
		/Applications/gmvault-v1.8.1-beta/bin/gmvault sync --multiple-db-owner --type quick aaronmk@nceas.ucsb.edu
348
		open Thunderbird
349
		click the All Mail folder for each account and wait for it to download the e-mails in it
350
	to back up the version history:
351
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
352
		svnsync sync file:///home/aaronmk/Dropbox/docs/BIEN/svn_repo/ # initial runtime: 1.5 h ("08:21:38" - "06:45:26") @vegbiendev
353
		(cd ~/Dropbox/docs/BIEN/git/; git svn fetch)
354
		overwrite=1        src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:~' put Dropbox/docs/BIEN/svn_repo/ # runtime: 1 min ("1:05.08")
355
			then rerun with l=1 ...
356
		overwrite=1        src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:~' put Dropbox/docs/BIEN/git/
357
			then rerun with l=1 ...
358
		on local machine:
359
		overwrite=1 swap=1 src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:~' put Dropbox/docs/BIEN/svn_repo/ # runtime: 30 s ("36.19")
360
			then rerun with l=1 ...
361
		overwrite=1 swap=1 src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:~' put Dropbox/docs/BIEN/git/
362
			then rerun with l=1 ...
363
	to synchronize a Mac's settings with my testing machine's:
364
		download:
365
			**WARNING**: this will overwrite all your user's settings!
366
			on your machine:
367
			overwrite=1 swap=1 sync_local_dir=~/Library/ sync_remote_subdir=Library/ bin/sync_upload --exclude="/Saved Application State"
368
				then rerun with l=1 ...
369
		upload:
370
			do step when changes are made on vegbiendev > on your machine, download
371
			ssh aaronmk@jupiter.nceas.ucsb.edu
372
				(cd ~/Dropbox/svn/; up)
373
			on your machine:
374
				rm ~/'Library/Thunderbird/Profiles/9oo8rcyn.default/ImapMail/imap.googlemail.com/[Gmail].sbd/Spam'
375
					# remove the downloaded Spam folder, because spam e-mails often contain viruses that would trigger clamscan
376
				overwrite=1 del= sync_local_dir=~/Dropbox/svn/ sync_remote_subdir=Dropbox/svn/ bin/sync_upload --size-only # just update mtimes
377
					then rerun with l=1 ...
378
				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"
379
					then rerun with l=1 ...
380
				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"
381
					then rerun with l=1 ...
382
		upload just the VirtualBox VMs:
383
			on your machine:
384
				overwrite=1      sync_local_dir=~              sync_remote_subdir=             bin/sync_upload ~/"VirtualBox VMs/**"
385
					then rerun with l=1 ...
386
	to backup files not in Time Machine:
387
		On local machine:
388
		overwrite=1 src=/ dest=/Volumes/Time\ Machine\ Backups/ sudo -E put Library/PostgreSQL/9.3/data/
389
			then rerun with l=1 ...
390
		pg_ctl. stop # stop the PostgreSQL server
391
		overwrite=1 src=/ dest=/Volumes/Time\ Machine\ Backups/ sudo -E put Library/PostgreSQL/9.3/data/
392
			then rerun with l=1 ...
393
		pg_ctl. start # start the PostgreSQL server
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: see inputs/run
402
				time yes|make inputs/{NVS,SALVIAS,TEAM}/test # old-style import; runtime: 1 min ("0m59.692s") @starscream
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
	update mappings and staging table column names:
479
		on local machine:
480
			inputs/run postprocess # runtime: see inputs/run
481
			time yes|make inputs/{NVS,SALVIAS,TEAM}/test # old-style import; runtime: 1 min ("0m59.692s") @starscream
482
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
483
			manually apply schema changes to the live public schema
484
			do steps under "on local machine" above
485
	Sync ERD with vegbien.sql schema:
486
		Run make schemas/vegbien.my.sql
487
		Open schemas/vegbien.ERD.mwb in MySQLWorkbench
488
		Go to File > Export > Synchronize With SQL CREATE Script...
489
		For Input File, select schemas/vegbien.my.sql
490
		Click Continue
491
		In the changes list, select each table with an arrow next to it
492
		Click Update Model
493
		Click Continue
494
		Note: The generated SQL script will be empty because we are syncing in
495
			the opposite direction
496
		Click Execute
497
		Reposition any lines that have been reset
498
		Add any new tables by dragging them from the Catalog in the left sidebar
499
			to the diagram
500
		Remove any deleted tables by right-clicking the table's diagram element,
501
			selecting Delete '<table name>', and clicking Delete
502
		Save
503
		If desired, update the graphical ERD exports (see below)
504
	Update graphical ERD exports:
505
		Go to File > Export > Export as PNG...
506
		Select schemas/vegbien.ERD.png and click Save
507
		Go to File > Export > Export as SVG...
508
		Select schemas/vegbien.ERD.svg and click Save
509
		Go to File > Export > Export as Single Page PDF...
510
		Select schemas/vegbien.ERD.1_pg.pdf and click Save
511
		Go to File > Print...
512
		In the lower left corner, click PDF > Save as PDF...
513
		Set the Title and Author to ""
514
		Select schemas/vegbien.ERD.pdf and click Save
515
		Commit: svn ci -m "schemas/vegbien.ERD.mwb: Regenerated exports"
516
	Refactoring tips:
517
		To rename a table:
518
			In vegbien.sql, do the following:
519
				Replace regexp (?<=_|\b)<old>(?=_|\b) with <new>
520
					This is necessary because the table name is *everywhere*
521
				Search for <new>
522
				Manually change back any replacements inside comments
523
		To rename a column:
524
			Rename the column: ALTER TABLE <table> RENAME <old> TO <new>;
525
			Recreate any foreign key for the column, removing CONSTRAINT <name>
526
				This resets the foreign key name using the new column name
527
	Creating a poster of the ERD:
528
		Determine the poster size:
529
			Measure the line height (from the bottom of one line to the bottom
530
				of another): 16.3cm/24 lines = 0.679cm
531
			Measure the height of the ERD: 35.4cm*2 = 70.8cm
532
			Zoom in as far as possible
533
			Measure the height of a capital letter: 3.5mm
534
			Measure the line height: 8.5mm
535
			Calculate the text's fraction of the line height: 3.5mm/8.5mm = 0.41
536
			Calculate the text height: 0.679cm*0.41 = 0.28cm
537
			Calculate the text height's fraction of the ERD height:
538
				0.28cm/70.8cm = 0.0040
539
			Measure the text height on the *VegBank* ERD poster: 5.5mm = 0.55cm
540
			Calculate the VegBIEN poster height to make the text the same size:
541
				0.55cm/0.0040 = 137.5cm H; *1in/2.54cm = 54.1in H
542
			The ERD aspect ratio is 11 in W x (2*8.5in H) = 11x17 portrait
543
			Calculate the VegBIEN poster width: 54.1in H*11W/17H = 35.0in W
544
			The minimum VegBIEN poster size is 35x54in portrait
545
		Determine the cost:
546
			The FedEx Kinkos near NCEAS (1030 State St, Santa Barbara, CA 93101)
547
				charges the following for posters:
548
				base: $7.25/sq ft
549
				lamination: $3/sq ft
550
				mounting on a board: $8/sq ft
551

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

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

    
587
WinMerge setup:
588
	In a Windows VM:
589
	Install WinMerge from <http://winmerge.org/>
590
	Open WinMerge
591
	Go to Edit > Options and click Compare in the left sidebar
592
	Enable "Moved block detection", as described at
593
		<http://manual.winmerge.org/Configuration.html#d0e5892>.
594
	Set Whitespace to Ignore change, as described at
595
		<http://manual.winmerge.org/Configuration.html#d0e5758>.
596

    
597
Documentation:
598
	To generate a Redmine-formatted list of steps for column-based import:
599
		On local machine:
600
		make schemas/public/reinstall
601
		make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
602
	To import and scrub just the test taxonomic names:
603
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo su - aaronmk
604
		inputs/test_taxonomic_names/test_scrub
605

    
606
General:
607
	To see a program's description, read its top-of-file comment
608
	To see a program's usage, run it without arguments
609
	To remake a directory: make <dir>/remake
610
	To remake a file: make <file>-remake
(6-6/11)