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 current 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 vegbiendev.nceas.ucsb.edu
12
	sudo su - aaronmk
13
	cd /home/bien/svn # should happen automatically at login
14

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

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

    
26
Single datasource import:
27
	Follow the steps under Connecting to vegbiendev above
28
	(Re)import and scrub: make inputs/<datasrc>/reimport_scrub by_col=1 &
29
	(Re)import only: make inputs/<datasrc>/reimport by_col=1 &
30
	Note that these commands also work if the datasource is not yet imported
31
	Remake analytical DB: see Full database import > To remake analytical DB
32

    
33
Full database import:
34
	WARNING: You must perform *every single* step listed below, to avoid
35
		breaking column-based import
36
	**WARNING**: always start with a clean shell, as described above under
37
		"Notes on running programs"
38
	Follow the steps under Connecting to vegbiendev above
39
	Follow the steps under Connecting to vegbiendev above, using jupiter instead
40
	On jupiter: 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
	On vegbiendev:
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
	set -o ignoreeof #prevent Ctrl+D from exiting `screen` to keep attached jobs
72
	unset TMOUT # TMOUT causes screen to exit even with background processes
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 creates
78
			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
	Upload logs (run on vegbiendev): make inputs/upload live=1
93
	On local machine: make inputs/download-logs live=1
94
	In PostgreSQL:
95
		Go to wiki.vegpath.org/VegBIEN_contents
96
		Get the # observations
97
		Get the # datasources
98
		Get the # datasources with observations
99
		in the r# schema:
100
		Check that analytical_stem contains [# observations] rows
101
		Check that source contains [# datasources] rows up through XAL
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
			On vegbiendev:
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
	On jupiter:
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
			On vegbiendev:
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
		On jupiter: svn up
297
		On local machine:
298
			./fix_perms
299
			make inputs/upload
300
			make inputs/upload live=1
301
		On vegbiendev:
302
			svn up
303
			make inputs/download
304
			make inputs/download live=1
305
			Follow the steps under Install the staging tables above
306

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

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

    
398
Backups:
399
	Archived imports:
400
		Follow the steps under Connecting to vegbiendev above
401
		Back up: make backups/<version>.backup &
402
			Note: To back up the last import, you must archive it first:
403
				make schemas/rotate
404
		Test: make -s backups/<version>.backup/test &
405
		Restore: make backups/<version>.backup/restore &
406
		Remove: make backups/<version>.backup/remove
407
		Download: make backups/<version>.backup/download
408
	TNRS cache:
409
		Follow the steps under Connecting to vegbiendev above
410
		Back up: make backups/TNRS.backup-remake &
411
			runtime: 3 min ("real 2m48.859s")
412
		Restore:
413
			yes|make inputs/.TNRS/uninstall
414
			make backups/TNRS.backup/restore &
415
				runtime: 5.5 min ("real 5m35.829s")
416
			yes|make schemas/public/reinstall
417
				Must come after TNRS restore to recreate tnrs_input_name view
418
	Full DB:
419
		Follow the steps under Connecting to vegbiendev above
420
		Back up: make backups/vegbien.<version>.backup &
421
		Test: make -s backups/vegbien.<version>.backup/test &
422
		Restore: make backups/vegbien.<version>.backup/restore &
423
		Download: make backups/vegbien.<version>.backup/download
424
	Import logs:
425
		On local machine:
426
		Download: make inputs/download-logs live=1
427

    
428
Datasource refreshing:
429
	VegBank:
430
		Follow the steps under Connecting to vegbiendev above
431
		make inputs/VegBank/vegbank.sql-remake
432
		make inputs/VegBank/reinstall quiet=1 &
433

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

    
525
Testing:
526
	On a development machine, you should put the following in your .profile:
527
		umask ug=rwx,o= # prevent files from becoming web-accessible
528
		export log= n=2
529
	For development machine specs, see /planning/resources/dev_machine.specs/
530
	On local machine:
531
	Mapping process: make test
532
		Including column-based import: make test by_col=1
533
			If the row-based and column-based imports produce different inserted
534
			row counts, this usually means that a table is underconstrained
535
			(the unique indexes don't cover all possible rows).
536
			This can occur if you didn't use COALESCE(field, null_value) around
537
			a nullable field in a unique index. See sql_gen.null_sentinels for
538
			the appropriate null value to use.
539
	Map spreadsheet generation: make remake
540
	Missing mappings: make missing_mappings
541
	Everything (for most complete coverage): make test-all
542

    
543
Debugging:
544
	"Binary chop" debugging:
545
		(This is primarily useful for regressions that occurred in a previous
546
		revision, which was committed without running all the tests)
547
		svn up -r <rev>; make inputs/.TNRS/reinstall; make schemas/public/reinstall; make <failed-test>.xml
548
	.htaccess:
549
		mod_rewrite:
550
			IMPORTANT: whenever you change the DirectorySlash setting for a
551
				directory, you *must* clear your browser's cache to ensure that
552
				a cached redirect is not used. this is because RewriteRule
553
				redirects are (by default) temporary, but DirectorySlash
554
				redirects are permanent.
555
				for Firefox:
556
					press Cmd+Shift+Delete
557
					check only Cache
558
					press Enter or click Clear Now
559

    
560
WinMerge setup:
561
	In a Windows VM:
562
	Install WinMerge from <http://winmerge.org/>
563
	Open WinMerge
564
	Go to Edit > Options and click Compare in the left sidebar
565
	Enable "Moved block detection", as described at
566
		<http://manual.winmerge.org/Configuration.html#d0e5892>.
567
	Set Whitespace to Ignore change, as described at
568
		<http://manual.winmerge.org/Configuration.html#d0e5758>.
569

    
570
Documentation:
571
	To generate a Redmine-formatted list of steps for column-based import:
572
		On local machine:
573
		make schemas/public/reinstall
574
		make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
575
	To import and scrub just the test taxonomic names:
576
		Follow the steps under Connecting to vegbiendev above
577
		inputs/test_taxonomic_names/test_scrub
578

    
579
General:
580
	To see a program's description, read its top-of-file comment
581
	To see a program's usage, run it without arguments
582
	To remake a directory: make <dir>/remake
583
	To remake a file: make <file>-remake
(6-6/11)