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
Single datasource import:
16
	Follow the steps under Connecting to vegbiendev above
17
	(Re)import and scrub: make inputs/<datasrc>/reimport_scrub by_col=1 &
18
	(Re)import only: make inputs/<datasrc>/reimport by_col=1 &
19
	Note that these commands also work if the datasource is not yet imported
20
	Remake analytical DB: see Full database import > To remake analytical DB
21

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

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

    
287
Maintenance:
288
	on a live machine, you should put the following in your .profile:
289
--
290
# make svn files web-accessible. this does not affect unversioned files, because
291
# these get the right permissions on the local machine instead.
292
umask ug=rwx,o=rx
293

    
294
unset TMOUT # TMOUT causes screen to exit even with background processes
295
--
296
	if http://vegbiendev.nceas.ucsb.edu/phppgadmin/ goes down:
297
		on vegbiendev: make postgres-Linux
298
	to synchronize vegbiendev, jupiter, and your local machine:
299
		WARNING: pay careful attention to all files that will be deleted or
300
			overwritten!
301
		install put if needed:
302
			download https://uutils.googlecode.com/svn/trunk/bin/put to ~/bin/ and `chmod +x` it
303
		when changes are made on vegbiendev:
304
			on all machines: ./fix_perms
305
			on vegbiendev, upload:
306
				overwrite=1 bin/sync_upload --size-only
307
					then rerun with l=1 ...
308
			on your machine, download:
309
				overwrite=1 swap=1 src=. dest='aaronmk@jupiter:~/bien' put --exclude=.svn inputs/VegBIEN/TWiki
310
					then rerun with l=1 ...
311
				overwrite=1 swap=1 bin/sync_upload --size-only
312
					then rerun with l=1 ...
313
				make backups/TNRS.backup/download live=1
314
				overwrite=1 sync_remote_url=~/Dropbox/svn/ bin/sync_upload --existing --size-only # just update mtimes/perms
315
					then rerun with l=1 ...
316
	to synchronize a Mac's settings with my testing machine's:
317
		download:
318
			WARNING: this will overwrite all your user's settings!
319
			on your machine:
320
			overwrite=1 swap=1 sync_local_dir=~/Library/ sync_remote_subdir=Library/ bin/sync_upload --exclude="/Saved Application State"
321
				then rerun with l=1 ...
322
		upload:
323
			do step when changes are made on vegbiendev > on your machine, download
324
			on jupiter: (cd ~/Dropbox/svn/; up)
325
			on your machine:
326
				overwrite=1 del= sync_local_dir=~/Dropbox/svn/ sync_remote_subdir=Dropbox/svn/ bin/sync_upload --size-only # just update mtimes
327
					then rerun with l=1 ...
328
				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"
329
					then rerun with l=1 ...
330
				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"
331
					then rerun with l=1 ...
332
		upload just the VirtualBox VMs:
333
			on your machine:
334
				overwrite=1      sync_local_dir=~              sync_remote_subdir=             bin/sync_upload ~/"VirtualBox VMs/**"
335
					then rerun with l=1 ...
336
	to backup files not in Time Machine:
337
		On local machine:
338
		src=/ dest=/Volumes/Time\ Machine\ Backups/ sudo -E put Library/PostgreSQL/9.3/data/
339
			then rerun with l=1 ...
340
		pg_ctl. stop # stop the PostgreSQL server
341
		src=/ dest=/Volumes/Time\ Machine\ Backups/ sudo -E put Library/PostgreSQL/9.3/data/
342
		pg_ctl. start # start the PostgreSQL server
343
	VegCore data dictionary:
344
		Regularly, or whenever the VegCore data dictionary page
345
			(https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCore)
346
			is changed, regenerate mappings/VegCore.csv:
347
			On local machine:
348
			make mappings/VegCore.htm-remake; make mappings/
349
			svn di mappings/VegCore.tables.redmine
350
			If there are changes, update the data dictionary's Tables section
351
			When moving terms, check that no terms were lost: svn di
352
			svn ci -m 'mappings/VegCore.htm: regenerated from wiki'
353
	Important: Whenever you install a system update that affects PostgreSQL or
354
		any of its dependencies, such as libc, you should restart the PostgreSQL
355
		server. Otherwise, you may get strange errors like "the database system
356
		is in recovery mode" which go away upon reimport, or you may not be able
357
		to access the database as the postgres superuser. This applies to both
358
		Linux and Mac OS X.
359

    
360
Backups:
361
	Archived imports:
362
		Follow the steps under Connecting to vegbiendev above
363
		Back up: make backups/<version>.backup &
364
			Note: To back up the last import, you must archive it first:
365
				make schemas/rotate
366
		Test: make -s backups/<version>.backup/test &
367
		Restore: make backups/<version>.backup/restore &
368
		Remove: make backups/<version>.backup/remove
369
		Download: make backups/<version>.backup/download
370
	TNRS cache:
371
		Follow the steps under Connecting to vegbiendev above
372
		Back up: make backups/TNRS.backup-remake &
373
			runtime: 3 min ("real 2m48.859s")
374
		Restore:
375
			yes|make inputs/.TNRS/uninstall
376
			make backups/TNRS.backup/restore &
377
				runtime: 5.5 min ("real 5m35.829s")
378
			yes|make schemas/public/reinstall
379
				Must come after TNRS restore to recreate tnrs_input_name view
380
	Full DB:
381
		Follow the steps under Connecting to vegbiendev above
382
		Back up: make backups/vegbien.<version>.backup &
383
		Test: make -s backups/vegbien.<version>.backup/test &
384
		Restore: make backups/vegbien.<version>.backup/restore &
385
		Download: make backups/vegbien.<version>.backup/download
386
	Import logs:
387
		On local machine:
388
		Download: make inputs/download-logs live=1
389

    
390
Datasource refreshing:
391
	VegBank:
392
		Follow the steps under Connecting to vegbiendev above
393
		make inputs/VegBank/vegbank.sql-remake
394
		make inputs/VegBank/reinstall quiet=1 &
395

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

    
487
Testing:
488
	On a development machine, you should put the following in your .profile:
489
		umask ug=rwx,o= # prevent files from becoming web-accessible
490
		export log= n=2
491
	On local machine:
492
	Mapping process: make test
493
		Including column-based import: make test by_col=1
494
			If the row-based and column-based imports produce different inserted
495
			row counts, this usually means that a table is underconstrained
496
			(the unique indexes don't cover all possible rows).
497
			This can occur if you didn't use COALESCE(field, null_value) around
498
			a nullable field in a unique index. See sql_gen.null_sentinels for
499
			the appropriate null value to use.
500
	Map spreadsheet generation: make remake
501
	Missing mappings: make missing_mappings
502
	Everything (for most complete coverage): make test-all
503

    
504
Debugging:
505
	"Binary chop" debugging:
506
		(This is primarily useful for regressions that occurred in a previous
507
		revision, which was committed without running all the tests)
508
		svn up -r <rev>; make inputs/.TNRS/reinstall; make schemas/public/reinstall; make <failed-test>.xml
509
	.htaccess:
510
		mod_rewrite:
511
			IMPORTANT: whenever you change the DirectorySlash setting for a
512
				directory, you *must* clear your browser's cache to ensure that
513
				a cached redirect is not used. this is because RewriteRule
514
				redirects are (by default) temporary, but DirectorySlash
515
				redirects are permanent.
516
				for Firefox:
517
					press Cmd+Shift+Delete
518
					check only Cache
519
					press Enter or click Clear Now
520

    
521
WinMerge setup:
522
	In a Windows VM:
523
	Install WinMerge from <http://winmerge.org/>
524
	Open WinMerge
525
	Go to Edit > Options and click Compare in the left sidebar
526
	Enable "Moved block detection", as described at
527
		<http://manual.winmerge.org/Configuration.html#d0e5892>.
528
	Set Whitespace to Ignore change, as described at
529
		<http://manual.winmerge.org/Configuration.html#d0e5758>.
530

    
531
Documentation:
532
	To generate a Redmine-formatted list of steps for column-based import:
533
		On local machine:
534
		make schemas/public/reinstall
535
		make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
536
	To import and scrub just the test taxonomic names:
537
		Follow the steps under Connecting to vegbiendev above
538
		inputs/test_taxonomic_names/test_scrub
539

    
540
General:
541
	To see a program's description, read its top-of-file comment
542
	To see a program's usage, run it without arguments
543
	To remake a directory: make <dir>/remake
544
	To remake a file: make <file>-remake
(5-5/10)