Project

General

Profile

1 702 aaronmk
Installation:
2 8458 aaronmk
	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 554 aaronmk
10 3674 aaronmk
Maintenance:
11 9399 aaronmk
	on a live machine, you should put the following in your .profile:
12
		umask ug=rwx,o= # prevent files from becoming web-accessible
13 9400 aaronmk
		unset TMOUT # TMOUT causes screen to exit even with background processes
14 8459 aaronmk
	to synchronize vegbiendev, jupiter, and your local machine:
15 9886 aaronmk
		WARNING: pay careful attention to all files that will be deleted or
16
			overwritten!
17 8460 aaronmk
		install put if needed:
18
			download https://uutils.googlecode.com/svn/trunk/bin/put to ~/bin/ and `chmod +x` it
19 8459 aaronmk
		when changes are made on vegbiendev:
20
			on vegbiendev, upload:
21 8723 aaronmk
				env overwrite=1             src=. dest='aaronmk@jupiter:~/bien' put --no-group --exclude=.svn --exclude=install.log.sql --exclude='*.backup' --exclude='/backups/analytical_aggregate.*.csv' --exclude='inputs/GBIF/**.data.sql' --exclude='bin/dotlockfile'
22 8459 aaronmk
					then rerun with env l=1 ...
23 8723 aaronmk
				env overwrite=1 del=        src=. dest='aaronmk@jupiter:~/bien' put --no-group --exclude=.svn --exclude=install.log.sql --exclude='inputs/GBIF/**.data.sql'
24 8459 aaronmk
					then rerun with env l=1 ...
25
			on your machine, download:
26 8945 aaronmk
				env overwrite=1      swap=1 src=. dest='aaronmk@jupiter:~/bien' put            --exclude=.svn inputs/VegBIEN/TWiki
27
					then rerun with env l=1 ...
28 8723 aaronmk
				env overwrite=1 del= swap=1 src=. dest='aaronmk@jupiter:~/bien' put            --exclude=.svn --exclude=install.log.sql --exclude='*.backup' --exclude='/backups/analytical_aggregate.*.csv' --exclude='inputs/GBIF/**.data.sql' --exclude='bin/dotlockfile'
29 8459 aaronmk
					then rerun with env l=1 ...
30 8462 aaronmk
	to synchronize a Mac's settings with my testing machine's:
31
		download:
32
			WARNING: this will overwrite all your user's settings!
33 8718 aaronmk
			env overwrite=1 swap=1 src=~/Library/ dest='aaronmk@jupiter:~/Library/' put --exclude="/Saved Application State"
34 8462 aaronmk
				then rerun with env l=1 ...
35
		upload:
36 8719 aaronmk
			do step when changes are made on vegbiendev > on your machine, download
37 8724 aaronmk
			env overwrite=1        src=~ dest='aaronmk@jupiter:~' put --exclude="/Library/Saved Application State" --exclude="/.Trash" --exclude="/bin" --exclude="/bin/pg_ctl" --exclude="/bin/unzip" --exclude="/Documents/BIEN/large_files" --exclude="/Documents/BIEN/svn/backups/*.backup" --exclude="/Documents/BIEN/svn/backups/analytical_aggregate.*.csv" --exclude="/Dropbox/home"
38 8462 aaronmk
				then rerun with env l=1 ...
39 8719 aaronmk
			env overwrite=1        src=~ dest=~/Dropbox/home      put --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"
40 8717 aaronmk
				then rerun with env l=1 ...
41 8720 aaronmk
	to backup files not in Time Machine:
42
		env inplace=1 src=/ dest=/Volumes/Time\ Machine\ Backups/ put Users/aaronmk/VirtualBox\ VMs/
43
			then rerun with env l=1 ...
44
		stop the PostgreSQL server
45
		sudo env src=/ dest=/Volumes/Time\ Machine\ Backups/ put Library/PostgreSQL/9.1/data/
46
			then rerun with env l=1 ...
47
		start the PostgreSQL server
48 8458 aaronmk
	VegCore data dictionary:
49
		Regularly, or whenever the VegCore data dictionary page
50
			(https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCore)
51
			is changed, regenerate mappings/VegCore.csv:
52
			make mappings/VegCore.htm-remake; make mappings/
53
			svn di mappings/VegCore.tables.redmine
54
			If there are changes, update the data dictionary's Tables section
55
			When moving terms, check that no terms were lost: svn di
56
			svn ci -m "mappings/VegCore.htm: Regenerated from wiki"
57
	Important: Whenever you install a system update that affects PostgreSQL or
58
		any of its dependencies, such as libc, you should restart the PostgreSQL
59
		server. Otherwise, you may get strange errors like "the database system
60
		is in recovery mode" which go away upon reimport, or you may not be able
61
		to access the database as the postgres superuser. This applies to both
62
		Linux and Mac OS X.
63 3674 aaronmk
64 7287 aaronmk
Single datasource import:
65 8458 aaronmk
	(Re)import and scrub: make inputs/<datasrc>/reimport_scrub by_col=1
66
	(Re)import only: make inputs/<datasrc>/reimport by_col=1
67
	(Re)scrub: make inputs/<datasrc>/rescrub by_col=1
68
	Note that these commands also work if the datasource is not yet imported
69 7287 aaronmk
70
Full database import:
71 9499 aaronmk
	WARNING: You must perform *every single* step listed below, to avoid
72
		breaking column-based import
73 9883 aaronmk
	On jupiter: svn up --force
74 8458 aaronmk
	On local machine:
75
		./fix_perms
76 9887 aaronmk
		do steps under Maintenance > "to synchronize vegbiendev, jupiter, and
77
			your local machine" above
78 9884 aaronmk
		make inputs/upload test=1
79 8458 aaronmk
		make inputs/upload
80
		make test by_col=1
81
			See note under Testing below
82
	On vegbiendev:
83
	Ensure there are no local modifications: svn st
84
	svn up
85 9884 aaronmk
	make inputs/download test=1
86 8458 aaronmk
	make inputs/download
87
	For each newly-uploaded datasource above: make inputs/<datasrc>/reinstall
88
	Update the auxiliary schemas: make schemas/reinstall
89
		The public schema will be installed separately by the import process
90
	Delete imports before the last so they won't bloat the full DB backup:
91
		make backups/vegbien.<version>.backup/remove
92
		To keep a previous import other than the public schema:
93
			export dump_opts='--exclude-schema=public --exclude-schema=<version>'
94
	Make sure there is at least 150GB of disk space on /: df -h
95
		The import schema is 100GB, and may use additional space for temp tables
96
		To free up space, remove backups that have been archived on jupiter:
97
			List backups/ to view older backups
98
			Check their MD5 sums using the steps under On jupiter below
99
			Remove these backups
100 9899 aaronmk
	Remove any leftover TNRS lockfile: rm inputs/.TNRS/tnrs/tnrs.make.lock
101
		Usually, the PID in it would not exist, but sometimes it now refers to
102
			a different, active process which blocks tnrs.make
103 8458 aaronmk
	screen
104
	Press ENTER
105 9531 aaronmk
	set -o ignoreeof #prevent Ctrl+D from exiting `screen` to keep attached jobs
106 9532 aaronmk
	unset TMOUT # TMOUT causes screen to exit even with background processes
107
	unset version
108 8458 aaronmk
	Start column-based import: . bin/import_all by_col=1
109
		To use row-based import: . bin/import_all
110
		To stop all running imports: . bin/stop_imports
111
		WARNING: Do NOT run import_all in the background, or the jobs it creates
112
			won't be owned by your shell.
113
		Note that import_all will take up to an hour to import the NCBI backbone
114
			and other metadata before returning control to the shell.
115
	Wait (overnight) for the import to finish
116
	To recover from a closed terminal window: screen -r
117
	When there are no more running jobs, exit the screen
118
	Get $version: echo $version
119
	Set $version in all vegbiendev terminals: export version=<version>
120
	Upload logs (run on vegbiendev): make inputs/upload
121
	On local machine: make inputs/download-logs
122
	In PostgreSQL:
123
		Check that the provider_count and source tables contain entries for all
124
			inputs
125 9492 aaronmk
	Check that TNRS ran successfully:
126
		tail -100 inputs/.TNRS/tnrs/logs/tnrs.make.log.sql
127
		If the log ends in an AssertionError
128
			"assert sql.table_col_names(db, table) == header":
129
			Figure out which TNRS CSV columns have changed
130
			On local machine:
131
				Make the changes in inputs/.TNRS/schema.sql
132
				rm inputs/.TNRS/tnrs/header.csv
133
				make inputs/.TNRS/reinstall schema_only=1
134
				make schemas/public/reinstall
135
				If there are errors "column ... does not exist", etc.:
136
					Make the necessary changes in schemas/vegbien.sql
137
					make schemas/public/reinstall
138
				make schemas/remake
139
				inputs/test_taxonomic_names/test_scrub
140 9528 aaronmk
				In inputs/test_taxonomic_names/_scrub/TNRS.sql, copy the
141
					"COPY tnrs ..." statement to inputs/.TNRS/data.sql
142 9492 aaronmk
				Commit
143
			On vegbiendev:
144
				If dropping a column, save the dependent views
145
				Make the same changes in the live TNRS.tnrs table on vegbiendev
146
				If dropping a column, recreate the dependent views
147
				Restart the TNRS client: make scrub by_col=1 &
148 8458 aaronmk
	tail inputs/{.,}*/*/logs/$version.log.sql
149
	In the output, search for "Command exited with non-zero status"
150
	For inputs that have this, fix the associated bug(s)
151
	If many inputs have errors, discard the current (partial) import:
152
		make schemas/$version/uninstall
153
	Otherwise, continue
154 9498 aaronmk
	Publish the new import:
155
		WARNING: Before proceeding, be sure you have done *every single*
156
			verification step listed above. Otherwise, a previous valid import
157
			could incorrectly be overwritten with a broken one.
158
		make schemas/$version/publish
159 8458 aaronmk
	unset version
160
	backups/fix_perms
161
	make backups/upload
162
	On jupiter:
163
		cd /data/dev/aaronmk/bien/backups
164
		For each newly-archived backup:
165
			make -s <backup>.md5/test
166
			Check that "OK" is printed next to the filename
167
	On nimoy:
168
		cd /home/bien/svn/
169
		svn up
170
		export version=<version>
171
		make backups/analytical_stem.$version.csv/download
172
		In the bien_web DB:
173
			Create the analytical_stem_<version> table using its schema
174
				in schemas/vegbien.my.sql
175
		make -s backups/analytical_stem.$version.csv.md5/test
176
		Check that "OK" is printed next to the filename
177
		env table=analytical_stem_$version bin/publish_analytical_db \
178
			backups/analytical_stem.$version.csv
179
	If desired, record the import times in inputs/import.stats.xls:
180
		Open inputs/import.stats.xls
181
		If the rightmost import is within 5 columns of column IV:
182
			Copy the current tab to <leftmost-date>~<rightmost-date>
183
			Remove the previous imports from the current tab because they are
184
				now in the copied tab instead
185
		Insert a copy of the leftmost "By column" column group before it
186
		export version=<version>
187
		bin/import_date inputs/{.,}*/*/logs/$version.log.sql
188
		Update the import date in the upper-right corner
189
		bin/import_times inputs/{.,}*/*/logs/$version.log.sql
190
		Paste the output over the # Rows/Time columns, making sure that the
191
			row counts match up with the previous import's row counts
192
		If the row counts do not match up, insert or reorder rows as needed
193
			until they do. Get the datasource names from the log file footers:
194
			tail inputs/{.,}*/*/logs/$version.log.sql
195
		Commit: svn ci -m "inputs/import.stats.xls: Updated import times"
196 9497 aaronmk
	To run TNRS:
197 8458 aaronmk
		export version=<version>
198 9497 aaronmk
		make scrub by_col=1 &
199 8458 aaronmk
		To view progress:
200
			tail -100 inputs/.TNRS/tnrs/logs/tnrs.make.log.sql
201 9497 aaronmk
	To remake analytical DB:
202 8458 aaronmk
		export version=<version>
203 9497 aaronmk
		bin/make_analytical_db &
204 8458 aaronmk
		To view progress:
205
			tail -100 inputs/analytical_db/logs/make_analytical_db.log.sql
206
	To back up DB (staging tables and last import):
207
		export version=<version>
208
		If before renaming to public: export dump_opts=--exclude-schema=public
209
		make backups/vegbien.$version.backup/test &
210 3381 aaronmk
211 3545 aaronmk
Backups:
212 8458 aaronmk
	Archived imports:
213
		Back up: make backups/<version>.backup &
214
			Note: To back up the last import, you must archive it first:
215
				make schemas/rotate
216
		Test: make -s backups/<version>.backup/test &
217
		Restore: make backups/<version>.backup/restore &
218
		Remove: make backups/<version>.backup/remove
219
		Download: make backups/download
220
	TNRS cache:
221
		Back up: make backups/TNRS.backup-remake &
222
		Restore:
223
			yes|make inputs/.TNRS/uninstall
224
			make backups/TNRS.backup/restore &
225
			yes|make schemas/public/reinstall
226
				Must come after TNRS restore to recreate tnrs_input_name view
227
	Full DB:
228
		Back up: make backups/vegbien.<version>.backup &
229
		Test: make -s backups/vegbien.<version>.backup/test &
230
		Restore: make backups/vegbien.<version>.backup/restore &
231
		Download: make backups/download
232
	Import logs:
233
		Download: make inputs/download-logs
234 554 aaronmk
235 1773 aaronmk
Datasource setup:
236 8469 aaronmk
	umask ug=rwx,o= # prevent files from becoming web-accessible
237 8458 aaronmk
	Add a new datasource: make inputs/<datasrc>/add
238
		<datasrc> may not contain spaces, and should be abbreviated.
239
		If the datasource is a herbarium, <datasrc> should be the herbarium code
240
			as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
241
	For MySQL inputs (exports and live DB connections):
242
		For .sql exports:
243
			Place the original .sql file in _src/ (*not* in _MySQL/)
244
			Follow the steps starting with Install the staging tables below.
245
				This is for an initial sync to get the file onto vegbiendev.
246
			On vegbiendev:
247
				Create a database for the MySQL export in phpMyAdmin
248 9494 aaronmk
				Give the bien user all database-specific privileges *except*
249
					UPDATE, DELETE, ALTER, DROP. This prevents bugs in the
250
					import scripts from accidentally deleting data.
251 8458 aaronmk
				bin/mysql_bien database <inputs/<datasrc>/_src/export.sql &
252
		mkdir inputs/<datasrc>/_MySQL/
253
		cp -p lib/MySQL.{data,schema}.sql.make inputs/<datasrc>/_MySQL/
254
		Edit _MySQL/*.make for the DB connection
255
			For a .sql export, use server=vegbiendev and --user=bien
256
		Skip the Add input data for each table section
257
	For MS Access databases:
258
		Place the .mdb or .accdb file in _src/
259
		Download and install Access To PostgreSQL from
260
			http://www.bullzip.com/download.php
261
		Use Access To PostgreSQL to export the database:
262
			Export just the tables/indexes to inputs/<datasrc>/<file>.schema.sql
263
			Export just the data to inputs/<datasrc>/<file>.data.sql
264
		In <file>.schema.sql, make the following changes:
265
			Replace text "BOOLEAN" with "/*BOOLEAN*/INTEGER"
266
			Replace text "DOUBLE PRECISION NULL" with "DOUBLE PRECISION"
267
		Skip the Add input data for each table section
268
	Add input data for each table present in the datasource:
269
		For .sql exports, you must use the name of the table in the DB export
270
		For CSV files, you can use any name. It's recommended to use a table
271
			name from <https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCSV#Suggested-table-names>
272
		Note that if this table will be joined together with another table, its
273
			name must end in ".src"
274
		make inputs/<datasrc>/<table>/add
275
			Important: DO NOT just create an empty directory named <table>!
276
				This command also creates necessary subdirs, such as logs/.
277
		If the table is in a .sql export: make inputs/<datasrc>/<table>/install
278
			Otherwise, place the CSV(s) for the table in
279
			inputs/<datasrc>/<table>/ OR place a query joining other tables
280
			together in inputs/<datasrc>/<table>/create.sql
281
		Important: When exporting relational databases to CSVs, you MUST ensure
282
			that embedded quotes are escaped by doubling them, *not* by
283
			preceding them with a "\" as is the default in phpMyAdmin
284
		If there are multiple part files for a table, and the header is repeated
285
			in each part, make sure each header is EXACTLY the same.
286 8466 aaronmk
			(If the headers are not the same, the CSV concatenation script
287
			assumes the part files don't have individual headers and treats the
288
			subsequent headers as data rows.)
289 8458 aaronmk
		Add <table> to inputs/<datasrc>/import_order.txt before other tables
290
			that depend on it
291
	Install the staging tables:
292
		make inputs/<datasrc>/reinstall quiet=1 &
293
		For a MySQL .sql export:
294
			At prompt "[you]@vegbiendev's password:", enter your password
295
			At prompt "Enter password:", enter the value in config/bien_password
296
		To view progress: tail -f inputs/<datasrc>/<table>/logs/install.log.sql
297
		View the logs: tail -n +1 inputs/<datasrc>/*/logs/install.log.sql
298
			tail provides a header line with the filename
299
			+1 starts at the first line, to show the whole file
300
		For every file with an error 'column "..." specified more than once':
301
			Add a header override file "+header.<ext>" in <table>/:
302
				Note: The leading "+" should sort it before the flat files.
303
					"_" unfortunately sorts *after* capital letters in ASCII.
304
				Create a text file containing the header line of the flat files
305
				Add an ! at the beginning of the line
306
					This signals cat_csv that this is a header override.
307
				For empty names, use their 0-based column # (by convention)
308
				For duplicate names, add a distinguishing suffix
309
				For long names that collided, rename them to <= 63 chars long
310
				Do NOT make readability changes in this step; that is what the
311
					map spreadsheets (below) are for.
312
				Save
313
		If you made any changes, re-run the install command above
314
	Auto-create the map spreadsheets: make inputs/<datasrc>/
315
	Map each table's columns:
316
		In each <table>/ subdir, for each "via map" map.csv:
317
			Open the map in a spreadsheet editor
318
			Open the "core map" /mappings/Veg+-VegBIEN.csv
319
			In each row of the via map, set the right column to a value from the
320
				left column of the core map
321
			Save
322
		Regenerate the derived maps: make inputs/<datasrc>/
323
	Accept the test cases:
324
		make inputs/<datasrc>/test
325
			When prompted to "Accept new test output", enter y and press ENTER
326
			If you instead get errors, do one of the following for each one:
327
			-	If the error was due to a bug, fix it
328
			-	Add a SQL function that filters or transforms the invalid data
329
			-	Make an empty mapping for the columns that produced the error.
330
				Put something in the Comments column of the map spreadsheet to
331
				prevent the automatic mapper from auto-removing the mapping.
332
			When accepting tests, it's helpful to use WinMerge
333
				(see WinMerge setup below for configuration)
334
		make inputs/<datasrc>/test by_col=1
335
			If you get errors this time, this always indicates a bug, usually in
336
				the VegBIEN unique constraints or column-based import itself
337
	Add newly-created files: make inputs/<datasrc>/add
338
	Commit: svn ci -m "Added inputs/<datasrc>/" inputs/<datasrc>/
339
	Update vegbiendev:
340
		On jupiter: svn up
341
		On local machine:
342
			./fix_perms
343 9950 aaronmk
			make inputs/upload test=1
344 8458 aaronmk
			make inputs/upload
345
		On vegbiendev:
346
			svn up
347 9950 aaronmk
			make inputs/download test=1
348 8458 aaronmk
			make inputs/download
349
			Follow the steps under Install the staging tables above
350 1773 aaronmk
351 6484 aaronmk
Datasource refreshing:
352 8458 aaronmk
	VegBank:
353
		make inputs/VegBank/vegbank.sql-remake
354
		make inputs/VegBank/reinstall quiet=1 &
355 6484 aaronmk
356 702 aaronmk
Schema changes:
357 8458 aaronmk
	When changing the analytical views, run sync_analytical_..._to_view()
358
		to update the corresponding table
359
	Remember to update the following files with any renamings:
360
		schemas/filter_ERD.csv
361
		mappings/VegCore-VegBIEN.csv
362
		mappings/verify.*.sql
363
	Regenerate schema from installed DB: make schemas/remake
364
	Reinstall DB from schema: make schemas/public/reinstall schemas/reinstall
365
		WARNING: This will delete the current public schema of your VegBIEN DB!
366 8837 aaronmk
	Reinstall staging tables:
367
		On local machine:
368 8840 aaronmk
			sudo -E -u postgres psql <<<'ALTER DATABASE vegbien RENAME TO vegbien_prev'
369 8845 aaronmk
			make db
370 8837 aaronmk
			. bin/reinstall_all
371
			Fix any bugs and retry until no errors
372 8846 aaronmk
			make schemas/public/install
373
				This must be run *after* the datasources are installed, because
374
				views in public depend on some of the datasources
375 8842 aaronmk
			sudo -E -u postgres psql <<<'DROP DATABASE vegbien_prev'
376 8841 aaronmk
		On vegbiendev: repeat the above steps
377 8837 aaronmk
			WARNING: Do not run this until reinstall_all runs successfully on
378
			the local machine, or the live DB may be unrestorable!
379 8458 aaronmk
	Sync ERD with vegbien.sql schema:
380
		Run make schemas/vegbien.my.sql
381
		Open schemas/vegbien.ERD.mwb in MySQLWorkbench
382
		Go to File > Export > Synchronize With SQL CREATE Script...
383
		For Input File, select schemas/vegbien.my.sql
384
		Click Continue
385
		In the changes list, select each table with an arrow next to it
386
		Click Update Model
387
		Click Continue
388
		Note: The generated SQL script will be empty because we are syncing in
389
			the opposite direction
390
		Click Execute
391
		Reposition any lines that have been reset
392
		Add any new tables by dragging them from the Catalog in the left sidebar
393
			to the diagram
394
		Remove any deleted tables by right-clicking the table's diagram element,
395
			selecting Delete '<table name>', and clicking Delete
396
		Save
397
		If desired, update the graphical ERD exports (see below)
398
	Update graphical ERD exports:
399
		Go to File > Export > Export as PNG...
400
		Select schemas/vegbien.ERD.png and click Save
401
		Go to File > Export > Export as SVG...
402
		Select schemas/vegbien.ERD.svg and click Save
403
		Go to File > Export > Export as Single Page PDF...
404
		Select schemas/vegbien.ERD.1_pg.pdf and click Save
405
		Go to File > Print...
406
		In the lower left corner, click PDF > Save as PDF...
407
		Set the Title and Author to ""
408
		Select schemas/vegbien.ERD.pdf and click Save
409
		Commit: svn ci -m "schemas/vegbien.ERD.mwb: Regenerated exports"
410
	Refactoring tips:
411
		To rename a table:
412
			In vegbien.sql, do the following:
413
				Replace regexp (?<=_|\b)<old>(?=_|\b) with <new>
414
					This is necessary because the table name is *everywhere*
415
				Search for <new>
416
				Manually change back any replacements inside comments
417
		To rename a column:
418
			Rename the column: ALTER TABLE <table> RENAME <old> TO <new>;
419
			Recreate any foreign key for the column, removing CONSTRAINT <name>
420
				This resets the foreign key name using the new column name
421
	Creating a poster of the ERD:
422
		Determine the poster size:
423
			Measure the line height (from the bottom of one line to the bottom
424
				of another): 16.3cm/24 lines = 0.679cm
425
			Measure the height of the ERD: 35.4cm*2 = 70.8cm
426
			Zoom in as far as possible
427
			Measure the height of a capital letter: 3.5mm
428
			Measure the line height: 8.5mm
429
			Calculate the text's fraction of the line height: 3.5mm/8.5mm = 0.41
430
			Calculate the text height: 0.679cm*0.41 = 0.28cm
431
			Calculate the text height's fraction of the ERD height:
432
				0.28cm/70.8cm = 0.0040
433
			Measure the text height on the *VegBank* ERD poster: 5.5mm = 0.55cm
434
			Calculate the VegBIEN poster height to make the text the same size:
435
				0.55cm/0.0040 = 137.5cm H; *1in/2.54cm = 54.1in H
436
			The ERD aspect ratio is 11 in W x (2*8.5in H) = 11x17 portrait
437
			Calculate the VegBIEN poster width: 54.1in H*11W/17H = 35.0in W
438
			The minimum VegBIEN poster size is 35x54in portrait
439
		Determine the cost:
440
			The FedEx Kinkos near NCEAS (1030 State St, Santa Barbara, CA 93101)
441
				charges the following for posters:
442
				base: $7.25/sq ft
443
				lamination: $3/sq ft
444
				mounting on a board: $8/sq ft
445 203 aaronmk
446 1459 aaronmk
Testing:
447 8458 aaronmk
	On a development machine, you should put the following in your .profile:
448 8469 aaronmk
		umask ug=rwx,o= # prevent files from becoming web-accessible
449 8458 aaronmk
		export log= n=2
450
	Mapping process: make test
451
		Including column-based import: make test by_col=1
452
			If the row-based and column-based imports produce different inserted
453
			row counts, this usually means that a table is underconstrained
454
			(the unique indexes don't cover all possible rows).
455
			This can occur if you didn't use COALESCE(field, null_value) around
456
			a nullable field in a unique index. See sql_gen.null_sentinels for
457
			the appropriate null value to use.
458
	Map spreadsheet generation: make remake
459
	Missing mappings: make missing_mappings
460
	Everything (for most complete coverage): make test-all
461 702 aaronmk
462 7183 aaronmk
Debugging:
463 8458 aaronmk
	"Binary chop" debugging:
464
		(This is primarily useful for regressions that occurred in a previous
465
		revision, which was committed without running all the tests)
466
		svn up -r <rev>; make inputs/.TNRS/reinstall; make schemas/public/reinstall; make <failed-test>.xml
467 8470 aaronmk
	.htaccess:
468
		mod_rewrite:
469 8471 aaronmk
			IMPORTANT: whenever you change the DirectorySlash setting for a
470
				directory, you *must* clear your browser's cache to ensure that
471
				a cached redirect is not used. this is because RewriteRule
472
				redirects are (by default) temporary, but DirectorySlash
473
				redirects are permanent.
474 8470 aaronmk
				for Firefox:
475
					press Cmd+Shift+Delete
476
					check only Cache
477
					press Enter or click Clear Now
478 7183 aaronmk
479 3783 aaronmk
WinMerge setup:
480 8458 aaronmk
	Install WinMerge from <http://winmerge.org/>
481
	Open WinMerge
482
	Go to Edit > Options and click Compare in the left sidebar
483
	Enable "Moved block detection", as described at
484
		<http://manual.winmerge.org/Configuration.html#d0e5892>.
485
	Set Whitespace to Ignore change, as described at
486
		<http://manual.winmerge.org/Configuration.html#d0e5758>.
487 3783 aaronmk
488 3133 aaronmk
Documentation:
489 8458 aaronmk
	To generate a Redmine-formatted list of steps for column-based import:
490
		make schemas/public/reinstall
491
		make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
492
	To import and scrub just the test taxonomic names:
493
		inputs/test_taxonomic_names/test_scrub
494 3133 aaronmk
495 702 aaronmk
General:
496 8458 aaronmk
	To see a program's description, read its top-of-file comment
497
	To see a program's usage, run it without arguments
498
	To remake a directory: make <dir>/remake
499
	To remake a file: make <file>-remake