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

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

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

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

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

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

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

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

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

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

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

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