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 editing files:
16
	**WARNING**: shell scripts should always be read-only, so that editing them
17
		while an import is in progress will not crash the import (see
18
		http://vegpath.org/links/#**%20modifying%20a%20running%20shell%20script)
19

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

    
27
Full database import:
28
	WARNING: You must perform *every single* step listed below, to avoid
29
		breaking column-based import
30
	WARNING: always start with a clean shell, which does not have changes to the
31
		env vars. (there have been bugs that went away after closing and
32
		reopening the terminal window.) note that running `exec bash` is not
33
		sufficient to *reset* the env vars.
34
	Follow the steps under Connecting to vegbiendev above
35
	Follow the steps under Connecting to vegbiendev above, using jupiter instead
36
	On jupiter: svn up --force
37
	On local machine:
38
		do steps under Maintenance > "to synchronize vegbiendev, jupiter, and
39
			your local machine"
40
		make inputs/upload
41
		make inputs/upload live=1
42
		make test by_col=1
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
	On vegbiendev:
47
	Ensure there are no local modifications: svn st
48
	svn 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 300GB of disk space on /: df -h
60
		The import schema is 230GB, 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
	set -o ignoreeof #prevent Ctrl+D from exiting `screen` to keep attached jobs
68
	unset TMOUT # TMOUT causes screen to exit even with background processes
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 creates
74
			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
	Wait (4 days) for the import to finish
78
	To recover from a closed terminal window: screen -r
79
	To restart an aborted import for a specific table:
80
		export version=<version>
81
		(set -o errexit; make inputs/<datasrc>/<table>/import_scrub by_col=1 continue=1; make inputs/<datasrc>/publish) &
82
		bin/after_import $! & # $! can also be obtained from `jobs -l`
83
	Get $version: echo $version
84
	Set $version in all vegbiendev terminals: export version=<version>
85
	When there are no more running jobs, exit the screen
86
	Upload logs (run on vegbiendev): make inputs/upload live=1
87
	On local machine: make inputs/download-logs live=1
88
	In PostgreSQL:
89
		Go to wiki.vegpath.org/VegBIEN_contents
90
		Get the # observations
91
		Get the # datasources
92
		Get the # datasources with observations
93
		in the r# schema:
94
		Check that analytical_stem contains [# observations] rows
95
		Check that source contains [# datasources] rows up through XAL
96
		Check that provider_count contains [# datasources with observations]
97
			rows with dataset="(total)" (at the top when the table is unsorted)
98
	Check that TNRS ran successfully:
99
		tail -100 inputs/.TNRS/tnrs/logs/tnrs.make.log.sql
100
		If the log ends in an AssertionError
101
			"assert sql.table_col_names(db, table) == header":
102
			Figure out which TNRS CSV columns have changed
103
			On local machine:
104
				Make the changes in the DB's TNRS and public schemas
105
				rm=1 inputs/.TNRS/schema.sql.run export_
106
				make schemas/remake
107
				inputs/test_taxonomic_names/test_scrub # re-run TNRS
108
				rm=1 inputs/.TNRS/data.sql.run export_
109
				Commit
110
			On vegbiendev:
111
				If dropping a column, save the dependent views
112
				Make the same changes in the live TNRS.tnrs table on vegbiendev
113
				If dropping a column, recreate the dependent views
114
				Restart the TNRS client: make scrub by_col=1 &
115
	tail inputs/{.,}*/*/logs/$version.log.sql
116
	In the output, search for "Command exited with non-zero status"
117
	For inputs that have this, fix the associated bug(s)
118
	If many inputs have errors, discard the current (partial) import:
119
		make schemas/$version/uninstall
120
	Otherwise, continue
121
	Publish the new import:
122
		WARNING: Before proceeding, be sure you have done *every single*
123
			verification step listed above. Otherwise, a previous valid import
124
			could incorrectly be overwritten with a broken one.
125
		make schemas/$version/publish # runtime: 1 min ("real 1m10.451s")
126
	unset version
127
	make backups/upload live=1
128
	on local machine:
129
		make backups/vegbien.$version.backup/download live=1
130
			# download backup to local machine
131
	On jupiter:
132
		cd /data/dev/aaronmk/bien/backups
133
		For each newly-archived backup:
134
			make -s <backup>.md5/test
135
			Check that "OK" is printed next to the filename
136
	If desired, record the import times in inputs/import.stats.xls:
137
		On local machine:
138
		Open inputs/import.stats.xls
139
		If the rightmost import is within 5 columns of column IV:
140
			Copy the current tab to <leftmost-date>~<rightmost-date>
141
			Remove the previous imports from the current tab because they are
142
				now in the copied tab instead
143
		Insert a copy of the leftmost "By column" column group before it
144
		export version=<version>
145
		bin/import_date inputs/{.,}*/*/logs/$version.log.sql
146
		Update the import date in the upper-right corner
147
		bin/import_times inputs/{.,}*/*/logs/$version.log.sql
148
		Paste the output over the # Rows/Time columns, making sure that the
149
			row counts match up with the previous import's row counts
150
		If the row counts do not match up, insert or reorder rows as needed
151
			until they do. Get the datasource names from the log file footers:
152
			tail inputs/{.,}*/*/logs/$version.log.sql
153
		Commit: svn ci -m 'inputs/import.stats.xls: updated import times'
154
	Running individual steps separately:
155
	To run TNRS:
156
		To use an import other than public: export version=<version>
157
		make scrub &
158
		To view progress:
159
			tail -100 inputs/.TNRS/tnrs/logs/tnrs.make.log.sql
160
	To remake analytical DB:
161
		To use an import other than public: export version=<version>
162
		bin/make_analytical_db & # runtime: 13 h ("12:43:57elapsed")
163
		To view progress:
164
			tail -150 inputs/analytical_db/logs/make_analytical_db.log.sql
165
	To back up DB (staging tables and last import):
166
		To use an import *other than public*: export version=<version>
167
		make backups/TNRS.backup-remake &
168
		dump_opts=--exclude-schema=public make backups/vegbien.$version.backup/test &
169
			If after renaming to public, instead set dump_opts='' and replace
170
			$version with the appropriate revision
171
		make backups/upload live=1
172

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

    
301
Maintenance:
302
	on a live machine, you should put the following in your .profile:
303
--
304
# make svn files web-accessible. this does not affect unversioned files, because
305
# these get the right permissions on the local machine instead.
306
umask ug=rwx,o=rx
307

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

    
383
Backups:
384
	Archived imports:
385
		Follow the steps under Connecting to vegbiendev above
386
		Back up: make backups/<version>.backup &
387
			Note: To back up the last import, you must archive it first:
388
				make schemas/rotate
389
		Test: make -s backups/<version>.backup/test &
390
		Restore: make backups/<version>.backup/restore &
391
		Remove: make backups/<version>.backup/remove
392
		Download: make backups/<version>.backup/download
393
	TNRS cache:
394
		Follow the steps under Connecting to vegbiendev above
395
		Back up: make backups/TNRS.backup-remake &
396
			runtime: 3 min ("real 2m48.859s")
397
		Restore:
398
			yes|make inputs/.TNRS/uninstall
399
			make backups/TNRS.backup/restore &
400
				runtime: 5.5 min ("real 5m35.829s")
401
			yes|make schemas/public/reinstall
402
				Must come after TNRS restore to recreate tnrs_input_name view
403
	Full DB:
404
		Follow the steps under Connecting to vegbiendev above
405
		Back up: make backups/vegbien.<version>.backup &
406
		Test: make -s backups/vegbien.<version>.backup/test &
407
		Restore: make backups/vegbien.<version>.backup/restore &
408
		Download: make backups/vegbien.<version>.backup/download
409
	Import logs:
410
		On local machine:
411
		Download: make inputs/download-logs live=1
412

    
413
Datasource refreshing:
414
	VegBank:
415
		Follow the steps under Connecting to vegbiendev above
416
		make inputs/VegBank/vegbank.sql-remake
417
		make inputs/VegBank/reinstall quiet=1 &
418

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

    
510
Testing:
511
	On a development machine, you should put the following in your .profile:
512
		umask ug=rwx,o= # prevent files from becoming web-accessible
513
		export log= n=2
514
	For development machine specs, see /planning/resources/dev_machine.specs/
515
	On local machine:
516
	Mapping process: make test
517
		Including column-based import: make test by_col=1
518
			If the row-based and column-based imports produce different inserted
519
			row counts, this usually means that a table is underconstrained
520
			(the unique indexes don't cover all possible rows).
521
			This can occur if you didn't use COALESCE(field, null_value) around
522
			a nullable field in a unique index. See sql_gen.null_sentinels for
523
			the appropriate null value to use.
524
	Map spreadsheet generation: make remake
525
	Missing mappings: make missing_mappings
526
	Everything (for most complete coverage): make test-all
527

    
528
Debugging:
529
	"Binary chop" debugging:
530
		(This is primarily useful for regressions that occurred in a previous
531
		revision, which was committed without running all the tests)
532
		svn up -r <rev>; make inputs/.TNRS/reinstall; make schemas/public/reinstall; make <failed-test>.xml
533
	.htaccess:
534
		mod_rewrite:
535
			IMPORTANT: whenever you change the DirectorySlash setting for a
536
				directory, you *must* clear your browser's cache to ensure that
537
				a cached redirect is not used. this is because RewriteRule
538
				redirects are (by default) temporary, but DirectorySlash
539
				redirects are permanent.
540
				for Firefox:
541
					press Cmd+Shift+Delete
542
					check only Cache
543
					press Enter or click Clear Now
544

    
545
WinMerge setup:
546
	In a Windows VM:
547
	Install WinMerge from <http://winmerge.org/>
548
	Open WinMerge
549
	Go to Edit > Options and click Compare in the left sidebar
550
	Enable "Moved block detection", as described at
551
		<http://manual.winmerge.org/Configuration.html#d0e5892>.
552
	Set Whitespace to Ignore change, as described at
553
		<http://manual.winmerge.org/Configuration.html#d0e5758>.
554

    
555
Documentation:
556
	To generate a Redmine-formatted list of steps for column-based import:
557
		On local machine:
558
		make schemas/public/reinstall
559
		make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
560
	To import and scrub just the test taxonomic names:
561
		Follow the steps under Connecting to vegbiendev above
562
		inputs/test_taxonomic_names/test_scrub
563

    
564
General:
565
	To see a program's description, read its top-of-file comment
566
	To see a program's usage, run it without arguments
567
	To remake a directory: make <dir>/remake
568
	To remake a file: make <file>-remake
(5-5/10)