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

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

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

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

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

    
417
Datasource refreshing:
418
	VegBank:
419
		Follow the steps under Connecting to vegbiendev above
420
		make inputs/VegBank/vegbank.sql-remake
421
		make inputs/VegBank/reinstall quiet=1 &
422

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

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

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

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

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

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