Project

General

Profile

1 702 aaronmk
Installation:
2 14747 aaronmk
	open a terminal window
3 13764 aaronmk
	Check out svn:
4 14742 aaronmk
		sudo apt-get --yes install subversion # not preinstalled on Ubuntu
5 13764 aaronmk
		svn co https://code.nceas.ucsb.edu/code/projects/bien/trunk bien
6 8458 aaronmk
	cd bien/
7 14699 aaronmk
	Install:
8 12226 aaronmk
		**WARNING**: This will delete the public schema of your VegBIEN DB!
9 14699 aaronmk
		make install
10 14743 aaronmk
		# at "reload PATH" (if displayed), do what it says
11 14746 aaronmk
		# at "Are you sure you want to continue connecting", type "yes" and
12
			press Enter
13 14756 aaronmk
		# at "aaronmk@jupiter's password", enter the applicable password
14 14699 aaronmk
		# at "[sudo] password for user", enter your password and press Enter
15
		# at "Modifying postgresql.conf and pg_hba.conf", type y and press Enter
16
		# at "kernel.shmmax [...] Press ENTER to continue":
17
			# open a new window
18
			# run what it says
19
			# press Ctrl-D
20
			# return to the previous window
21
			# press Enter
22
		# at "restart PostgreSQL manually ... Press ENTER to continue":
23
			# open a new window
24
			# run what it says
25
			# press Ctrl-D
26
			# return to the previous window
27
			# press Enter
28
		# at "This will delete the current public schema of your VegBIEN DB",
29
			type y and press Enter
30 14757 aaronmk
		# at "If asked for MySQL root password", copy the password to the
31
			clipboard and press Enter
32
		# at "Web server to reconfigure automatically", select apache2 and click
33
			Ok
34
		# at "Configure database for phpmyadmin with dbconfig-common?", click
35
			Yes
36
		# at "Password of the database's administrative user", paste the
37
			password and click Ok
38
		# at "MySQL application password for phpmyadmin", just click Ok
39
		# at "An error occurred while installing the database", click Ok
40
		# at "Next step for database installation", select ignore and click Ok
41 14758 aaronmk
		# at "aaronmk@jupiter's password", enter the applicable password
42 8458 aaronmk
	Uninstall: make uninstall
43 12226 aaronmk
		**WARNING**: This will delete your entire VegBIEN DB!
44 8458 aaronmk
		This includes all archived imports and staging tables.
45 554 aaronmk
46 11515 aaronmk
Connecting to vegbiendev:
47 13284 aaronmk
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
48 13763 aaronmk
	cd /home/bien # should happen automatically at login
49 11515 aaronmk
50 14651 aaronmk
Single datasource refresh:
51 14653 aaronmk
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
52 14651 aaronmk
	# -> Maintenance > to back up the vegbiendev databases
53 14787 aaronmk
	# place updated extract in inputs/$datasrc/_src/
54 14654 aaronmk
	# place extracted flat file(s) in the appropriate table subdirs
55 14651 aaronmk
	rm=1 inputs/<datasrc>/run # reload staging tables
56
	make inputs/<datasrc>/reimport_scrub by_col=1 &
57
		# this works whether or not datasource is already imported
58 14652 aaronmk
	tail -150 inputs/<datasrc>/*/logs/public.log.sql # view progress
59 14651 aaronmk
	# -> Full database import > To re-run geoscrubbing
60
	# -> Full database import > To remake analytical DB
61 14791 aaronmk
	# -> Full database import > To back up DB
62 14651 aaronmk
	# -> Maintenance > to back up the vegbiendev databases
63
64 14788 aaronmk
datasource removal:
65
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
66 14868 aaronmk
	$ make inputs/$datasrc/rm # runtime: see
67
		# http://vegpath.org/wiki/Individual_datasource_refresh#datasource-removal-runtimes
68 14788 aaronmk
69 13024 aaronmk
Notes on system stability:
70 14091 aaronmk
	**WARNING**: when shutting down the VM, always first stop Postgres:
71
		sudo service postgresql stop
72
		this prevents the OS from SIGKILLing Postgres, which sometimes causes
73
		database corruption
74 13024 aaronmk
75 12011 aaronmk
Notes on running programs:
76
	**WARNING**: always start with a clean shell, to avoid spurious bugs. the
77
		shell should not have changes to the env vars. (there have been bugs
78
		that went away after closing and reopening the terminal window.) note
79
		that running `exec bash` is not sufficient to *reset* the env vars.
80
81 11967 aaronmk
Notes on editing files:
82
	**WARNING**: shell scripts should always be read-only, so that editing them
83
		while an import is in progress will not crash the import (see
84
		http://vegpath.org/links/#**%20modifying%20a%20running%20shell%20script)
85
86 7287 aaronmk
Full database import:
87 12226 aaronmk
	**WARNING**: You must perform *every single* step listed below, to avoid
88 9499 aaronmk
		breaking column-based import
89 12011 aaronmk
	**WARNING**: always start with a clean shell, as described above under
90
		"Notes on running programs"
91 13021 aaronmk
	**IMPORTANT**: the beginning of the import should be scheduled at a time
92
		when the DB will not be needed for other uses. this is necessary because
93
		vegbiendev will be slow for the first few hours of the import, due to
94
		the import using all the available cores.
95 13000 aaronmk
	do steps under Maintenance > "to synchronize vegbiendev, jupiter, and
96
		your local machine"
97 8458 aaronmk
	On local machine:
98
		make inputs/upload
99 10025 aaronmk
		make inputs/upload live=1
100 14077 aaronmk
		make test by_col=1 # runtime: 1 h ("53m7.383s") @starscream
101 10549 aaronmk
			if you encounter errors, they are most likely related to the
102
				PostgreSQL error parsing in /lib/sql.py parse_exception()
103 8458 aaronmk
			See note under Testing below
104 14887 aaronmk
	-> Maintenance > to back up the vegbiendev databases > back up Postgres
105 13284 aaronmk
	ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
106 8458 aaronmk
	Ensure there are no local modifications: svn st
107 12998 aaronmk
	up
108 8458 aaronmk
	make inputs/download
109 10025 aaronmk
	make inputs/download live=1
110 8458 aaronmk
	For each newly-uploaded datasource above: make inputs/<datasrc>/reinstall
111
	Update the auxiliary schemas: make schemas/reinstall
112 12226 aaronmk
		**WARNING**: requires sudo access!
113 8458 aaronmk
		The public schema will be installed separately by the import process
114
	Delete imports before the last so they won't bloat the full DB backup:
115
		make backups/vegbien.<version>.backup/remove
116
		To keep a previous import other than the public schema:
117
			export dump_opts='--exclude-schema=public --exclude-schema=<version>'
118 13009 aaronmk
			# env var will be inherited by `screen` shell
119 13016 aaronmk
	restart Postgres to free up any disk space used by temp tables from the last
120
		import (this is apparently not automatically reclaimed):
121
		make postgres_restart
122 13022 aaronmk
	Make sure there is at least 1 TB of disk space on /: df -h
123
		although the import schema itself is only 315 GB, Postgres uses
124 13023 aaronmk
			significant temporary space at the beginning of the import.
125 13028 aaronmk
			the total disk usage oscillates between 1.2 TB and the entire disk
126
			for the first day (for import started @12:55:09, high-water marks of
127 13031 aaronmk
			1.7 TB @14:00:25, 1.8 TB @15:38:32; then next day w/ 2 datasources
128
			running: entire disk for 4 min @05:35:44, 1.8 TB @11:15:05).
129 8458 aaronmk
		To free up space, remove backups that have been archived on jupiter:
130
			List backups/ to view older backups
131
			Check their MD5 sums using the steps under On jupiter below
132
			Remove these backups
133 13423 aaronmk
	for full import:
134
		screen
135
		Press ENTER
136 14893 aaronmk
		unset TMOUT # TMOUT causes shell to exit even with background processes
137 14087 aaronmk
	$0 # nested shell to prevent errexit from closing the window
138 13422 aaronmk
	the following must happen within screen to avoid affecting the outer shell:
139 13428 aaronmk
	unset TMOUT # TMOUT causes shell to exit even with background processes
140
	set -o ignoreeof # prevent Ctrl+D from exiting shell to keep attached jobs
141 13426 aaronmk
	on local machine:
142
		unset n # clear any limit set in .profile (unless desired)
143
		unset log # allow logging output to go to log files
144 13424 aaronmk
	unset version # clear any version from last import, etc.
145
	if no commits have been made since the last import (eg. if retrying an
146
		import), set a custom version that differs from the auto-assigned one
147
		(would otherwise cause a collision with the last import):
148
		svn info
149
		extract the svn revision after "Revision:"
150
		export version=r[revision]_2 # +suffix to distinguish from last import
151
			# env var will be inherited by `screen` shell
152 13119 aaronmk
	to import just a subset of the datasources:
153 13427 aaronmk
		declare -ax inputs; inputs=(inputs/{src,...}/) # no () in declare on Mac
154 13119 aaronmk
			# array vars *not* inherited by `screen` shell
155
		export version=custom_import_name
156 10579 aaronmk
	Start column-based import: . bin/import_all
157
		To use row-based import: . bin/import_all by_col=
158 8458 aaronmk
		To stop all running imports: . bin/stop_imports
159 12226 aaronmk
		**WARNING**: Do NOT run import_all in the background, or the jobs it
160
			creates won't be owned by your shell.
161 8458 aaronmk
		Note that import_all will take up to an hour to import the NCBI backbone
162
			and other metadata before returning control to the shell.
163 12026 aaronmk
		To view progress:
164 14882 aaronmk
			tail inputs/{.[^as.],}*/*/logs/$version.log.sql
165 13020 aaronmk
	note: at the beginning of the import, the system may send out CPU load
166
		warning e-mails. these can safely be ignored. (they happen because the
167
		parallel imports use all the available cores.)
168 13425 aaronmk
	for test import, turn off DB backup (also turns off analytical DB creation):
169 13429 aaronmk
		kill % # cancel after_import()
170 10850 aaronmk
	Wait (4 days) for the import to finish
171 14197 aaronmk
	**WARNING**: do *not* run backups/pg_snapshot while the import is running,
172
		due to continuously-changing files
173
	**WARNING**: do *not* run backups/pg_snapshot until the previous import has
174
		been replaced, to avoid running into disk space limits
175 8458 aaronmk
	To recover from a closed terminal window: screen -r
176 10583 aaronmk
	To restart an aborted import for a specific table:
177
		export version=<version>
178 11800 aaronmk
		(set -o errexit; make inputs/<datasrc>/<table>/import_scrub by_col=1 continue=1; make inputs/<datasrc>/publish) &
179 10588 aaronmk
		bin/after_import $! & # $! can also be obtained from `jobs -l`
180 8458 aaronmk
	Get $version: echo $version
181
	Set $version in all vegbiendev terminals: export version=<version>
182 13017 aaronmk
	When there are no more running jobs, exit `screen`: exit # not Ctrl+D
183 13025 aaronmk
	upload logs: make inputs/upload live=1
184 10025 aaronmk
	On local machine: make inputs/download-logs live=1
185 13030 aaronmk
	check for disk space errors:
186 14882 aaronmk
		grep --files-with-matches -F 'No space left on device' inputs/{.[^as.],}*/*/logs/$version.log.sql
187 13030 aaronmk
		if there are any matches:
188
			manually reimport these datasources using the steps under
189
				Single datasource import
190
			bin/after_import &
191
			wait for the import to finish
192 14882 aaronmk
	tail inputs/{.[^as.],}*/*/logs/$version.log.sql
193 13029 aaronmk
	In the output, search for "Command exited with non-zero status"
194
	For inputs that have this, fix the associated bug(s)
195
	If many inputs have errors, discard the current (partial) import:
196
		make schemas/$version/uninstall
197
	Otherwise, continue
198 8458 aaronmk
	In PostgreSQL:
199 11568 aaronmk
		Go to wiki.vegpath.org/VegBIEN_contents
200 11728 aaronmk
		Get the # observations
201
		Get the # datasources
202
		Get the # datasources with observations
203 11892 aaronmk
		in the r# schema:
204 11569 aaronmk
		Check that analytical_stem contains [# observations] rows
205 12148 aaronmk
		Check that source contains [# datasources] rows up through XAL. If this
206
			is not the case, manually check the entries in source against the
207
			datasources list on the wiki page (some datasources may be near the
208
			end depending on import order).
209 11568 aaronmk
		Check that provider_count contains [# datasources with observations]
210
			rows with dataset="(total)" (at the top when the table is unsorted)
211 9492 aaronmk
	Check that TNRS ran successfully:
212
		tail -100 inputs/.TNRS/tnrs/logs/tnrs.make.log.sql
213
		If the log ends in an AssertionError
214
			"assert sql.table_col_names(db, table) == header":
215
			Figure out which TNRS CSV columns have changed
216
			On local machine:
217 10784 aaronmk
				Make the changes in the DB's TNRS and public schemas
218
				rm=1 inputs/.TNRS/schema.sql.run export_
219 9492 aaronmk
				make schemas/remake
220 10785 aaronmk
				inputs/test_taxonomic_names/test_scrub # re-run TNRS
221 10784 aaronmk
				rm=1 inputs/.TNRS/data.sql.run export_
222 9492 aaronmk
				Commit
223 13284 aaronmk
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
224 9492 aaronmk
				If dropping a column, save the dependent views
225
				Make the same changes in the live TNRS.tnrs table on vegbiendev
226
				If dropping a column, recreate the dependent views
227
				Restart the TNRS client: make scrub by_col=1 &
228 9498 aaronmk
	Publish the new import:
229 12226 aaronmk
		**WARNING**: Before proceeding, be sure you have done *every single*
230 9498 aaronmk
			verification step listed above. Otherwise, a previous valid import
231
			could incorrectly be overwritten with a broken one.
232 10864 aaronmk
		make schemas/$version/publish # runtime: 1 min ("real 1m10.451s")
233 8458 aaronmk
	unset version
234 10027 aaronmk
	make backups/upload live=1
235 11897 aaronmk
	on local machine:
236
		make backups/vegbien.$version.backup/download live=1
237
			# download backup to local machine
238 12396 aaronmk
	ssh aaronmk@jupiter.nceas.ucsb.edu
239 8458 aaronmk
		cd /data/dev/aaronmk/bien/backups
240
		For each newly-archived backup:
241
			make -s <backup>.md5/test
242
			Check that "OK" is printed next to the filename
243
	If desired, record the import times in inputs/import.stats.xls:
244 11573 aaronmk
		On local machine:
245 8458 aaronmk
		Open inputs/import.stats.xls
246 14878 aaronmk
		click the "current" tab
247 8458 aaronmk
		If the rightmost import is within 5 columns of column IV:
248
			Copy the current tab to <leftmost-date>~<rightmost-date>
249
			Remove the previous imports from the current tab because they are
250
				now in the copied tab instead
251
		Insert a copy of the leftmost "By column" column group before it
252
		export version=<version>
253 14882 aaronmk
		bin/import_date inputs/{.[^as.],}*/*/logs/$version.log.sql
254 8458 aaronmk
		Update the import date in the upper-right corner
255 14882 aaronmk
		bin/import_times inputs/{.[^as.],}*/*/logs/$version.log.sql
256 8458 aaronmk
		Paste the output over the # Rows/Time columns, making sure that the
257
			row counts match up with the previous import's row counts
258
		If the row counts do not match up, insert or reorder rows as needed
259
			until they do. Get the datasource names from the log file footers:
260 14882 aaronmk
			tail inputs/{.[^as.],}*/*/logs/$version.log.sql
261 14883 aaronmk
		update the Postprocessing times:
262
			analytical DB remake time:
263
				from the end of inputs/analytical_db/logs/make_analytical_db.log.sql,
264
					search upwards for "_individual_view_modify" followed by a
265
					line of -'s
266
				enter as: =[ms]/1000/3600/24
267 11573 aaronmk
		Commit: svn ci -m 'inputs/import.stats.xls: updated import times'
268 10885 aaronmk
	Running individual steps separately:
269 9497 aaronmk
	To run TNRS:
270 9996 aaronmk
		To use an import other than public: export version=<version>
271 13594 aaronmk
		to rescrub all names:
272
			make inputs/.TNRS/reinstall
273
			re-create public-schema views that were cascadingly deleted
274 9995 aaronmk
		make scrub &
275 8458 aaronmk
		To view progress:
276
			tail -100 inputs/.TNRS/tnrs/logs/tnrs.make.log.sql
277 14447 aaronmk
	To re-run geoscrubbing:
278
		$ screen
279 14871 aaronmk
		# press Enter
280 14802 aaronmk
		$ unset TMOUT # TMOUT causes shell to exit even with background processes
281 14530 aaronmk
		# to use an import other than public: $ export version=<version>
282
		$ bin/psql_verbose_vegbien <<<'SELECT geoscrub_input_view_modify();' &
283 14877 aaronmk
			# runtime: 6 min ("6:02.30") @r14827 @vegbiendev
284 14531 aaronmk
		# wait until done
285 14536 aaronmk
		$ rm=1 exports/geoscrub_input.csv.run
286 14877 aaronmk
			# runtime: 1 min ("1m2.962s") @r14827 @vegbiendev
287 14792 aaronmk
		$ $0 # subshell to avoid closing screen on errexit
288 14447 aaronmk
		$ rm=1 inputs/.geoscrub/geoscrub_output/geoscrub.csv.run &
289 14877 aaronmk
			# runtime: 1.5 h ("84m55.408s") @r14827 @vegbiendev
290 14447 aaronmk
		# wait until done
291 14798 aaronmk
		$ rm=1 inputs/.geoscrub/geoscrub_output/run &
292 14877 aaronmk
			# runtime: 12 min ("11m35.693s") @r14827 @vegbiendev
293 14447 aaronmk
		# wait until done
294 14824 aaronmk
		# re-create public-schema views that were cascadingly deleted (currently
295
			plot.**, view_full_occurrence_individual_view, geoscrub_input_new)
296 14447 aaronmk
		# press Ctrl+D
297
		# remake the analytical DB (below)
298 9497 aaronmk
	To remake analytical DB:
299 9996 aaronmk
		To use an import other than public: export version=<version>
300 11089 aaronmk
		bin/make_analytical_db & # runtime: 13 h ("12:43:57elapsed")
301 8458 aaronmk
		To view progress:
302 10600 aaronmk
			tail -150 inputs/analytical_db/logs/make_analytical_db.log.sql
303 8458 aaronmk
	To back up DB (staging tables and last import):
304 10578 aaronmk
		To use an import *other than public*: export version=<version>
305 10743 aaronmk
		make backups/TNRS.backup-remake &
306 10577 aaronmk
		dump_opts=--exclude-schema=public make backups/vegbien.$version.backup/test &
307 10578 aaronmk
			If after renaming to public, instead set dump_opts='' and replace
308
			$version with the appropriate revision
309 10744 aaronmk
		make backups/upload live=1
310 3381 aaronmk
311 1773 aaronmk
Datasource setup:
312 11516 aaronmk
	On local machine:
313 11090 aaronmk
	Example steps for a datasource: wiki.vegpath.org/Import_process_for_Madidi
314 8469 aaronmk
	umask ug=rwx,o= # prevent files from becoming web-accessible
315 8458 aaronmk
	Add a new datasource: make inputs/<datasrc>/add
316
		<datasrc> may not contain spaces, and should be abbreviated.
317
		If the datasource is a herbarium, <datasrc> should be the herbarium code
318
			as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
319 11018 aaronmk
	For a new-style datasource (one containing a ./run runscript):
320 11019 aaronmk
		"cp" -f inputs/.NCBI/{Makefile,run,table.run} inputs/<datasrc>/
321 8458 aaronmk
	For MySQL inputs (exports and live DB connections):
322
		For .sql exports:
323
			Place the original .sql file in _src/ (*not* in _MySQL/)
324
			Follow the steps starting with Install the staging tables below.
325
				This is for an initial sync to get the file onto vegbiendev.
326 13284 aaronmk
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
327 8458 aaronmk
				Create a database for the MySQL export in phpMyAdmin
328 9494 aaronmk
				Give the bien user all database-specific privileges *except*
329
					UPDATE, DELETE, ALTER, DROP. This prevents bugs in the
330
					import scripts from accidentally deleting data.
331 8458 aaronmk
				bin/mysql_bien database <inputs/<datasrc>/_src/export.sql &
332
		mkdir inputs/<datasrc>/_MySQL/
333
		cp -p lib/MySQL.{data,schema}.sql.make inputs/<datasrc>/_MySQL/
334
		Edit _MySQL/*.make for the DB connection
335
			For a .sql export, use server=vegbiendev and --user=bien
336
		Skip the Add input data for each table section
337
	For MS Access databases:
338
		Place the .mdb or .accdb file in _src/
339 14661 aaronmk
		Download and install Bullzip's MS Access to PostgreSQL from
340
			http://bullzip.com/download.php > Access To PostgreSQL > Download
341 8458 aaronmk
		Use Access To PostgreSQL to export the database:
342
			Export just the tables/indexes to inputs/<datasrc>/<file>.schema.sql
343 14662 aaronmk
				using the settings in the associated .ini file where available
344
			Export just the data to inputs/<datasrc>/<file>.data.sql using the
345
				settings in the associated .ini file where available
346 8458 aaronmk
		In <file>.schema.sql, make the following changes:
347 14813 aaronmk
			Replace text "^CREATE DATABASE .*?;$" with "/*$0*/"
348 8458 aaronmk
			Replace text "BOOLEAN" with "/*BOOLEAN*/INTEGER"
349
			Replace text "DOUBLE PRECISION NULL" with "DOUBLE PRECISION"
350
		Skip the Add input data for each table section
351
	Add input data for each table present in the datasource:
352
		For .sql exports, you must use the name of the table in the DB export
353
		For CSV files, you can use any name. It's recommended to use a table
354
			name from <https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCSV#Suggested-table-names>
355
		Note that if this table will be joined together with another table, its
356
			name must end in ".src"
357
		make inputs/<datasrc>/<table>/add
358
			Important: DO NOT just create an empty directory named <table>!
359
				This command also creates necessary subdirs, such as logs/.
360
		If the table is in a .sql export: make inputs/<datasrc>/<table>/install
361
			Otherwise, place the CSV(s) for the table in
362
			inputs/<datasrc>/<table>/ OR place a query joining other tables
363
			together in inputs/<datasrc>/<table>/create.sql
364
		Important: When exporting relational databases to CSVs, you MUST ensure
365
			that embedded quotes are escaped by doubling them, *not* by
366
			preceding them with a "\" as is the default in phpMyAdmin
367
		If there are multiple part files for a table, and the header is repeated
368
			in each part, make sure each header is EXACTLY the same.
369 8466 aaronmk
			(If the headers are not the same, the CSV concatenation script
370
			assumes the part files don't have individual headers and treats the
371
			subsequent headers as data rows.)
372 8458 aaronmk
		Add <table> to inputs/<datasrc>/import_order.txt before other tables
373
			that depend on it
374 11018 aaronmk
		For a new-style datasource:
375
			"cp" -f inputs/.NCBI/nodes/run inputs/<datasrc>/<table>/
376
			inputs/<datasrc>/<table>/run
377 8458 aaronmk
	Install the staging tables:
378
		make inputs/<datasrc>/reinstall quiet=1 &
379
		For a MySQL .sql export:
380
			At prompt "[you]@vegbiendev's password:", enter your password
381
			At prompt "Enter password:", enter the value in config/bien_password
382
		To view progress: tail -f inputs/<datasrc>/<table>/logs/install.log.sql
383
		View the logs: tail -n +1 inputs/<datasrc>/*/logs/install.log.sql
384
			tail provides a header line with the filename
385
			+1 starts at the first line, to show the whole file
386
		For every file with an error 'column "..." specified more than once':
387
			Add a header override file "+header.<ext>" in <table>/:
388
				Note: The leading "+" should sort it before the flat files.
389
					"_" unfortunately sorts *after* capital letters in ASCII.
390
				Create a text file containing the header line of the flat files
391
				Add an ! at the beginning of the line
392
					This signals cat_csv that this is a header override.
393
				For empty names, use their 0-based column # (by convention)
394
				For duplicate names, add a distinguishing suffix
395
				For long names that collided, rename them to <= 63 chars long
396
				Do NOT make readability changes in this step; that is what the
397
					map spreadsheets (below) are for.
398
				Save
399
		If you made any changes, re-run the install command above
400
	Auto-create the map spreadsheets: make inputs/<datasrc>/
401
	Map each table's columns:
402
		In each <table>/ subdir, for each "via map" map.csv:
403
			Open the map in a spreadsheet editor
404
			Open the "core map" /mappings/Veg+-VegBIEN.csv
405
			In each row of the via map, set the right column to a value from the
406
				left column of the core map
407
			Save
408
		Regenerate the derived maps: make inputs/<datasrc>/
409
	Accept the test cases:
410 11018 aaronmk
		For a new-style datasource:
411
			inputs/<datasrc>/run
412
			svn di inputs/<datasrc>/*/test.xml.ref
413
			If you get errors, follow the steps for old-style datasources below
414
		For an old-style datasource:
415
			make inputs/<datasrc>/test
416 8458 aaronmk
			When prompted to "Accept new test output", enter y and press ENTER
417
			If you instead get errors, do one of the following for each one:
418
			-	If the error was due to a bug, fix it
419
			-	Add a SQL function that filters or transforms the invalid data
420
			-	Make an empty mapping for the columns that produced the error.
421
				Put something in the Comments column of the map spreadsheet to
422
				prevent the automatic mapper from auto-removing the mapping.
423
			When accepting tests, it's helpful to use WinMerge
424
				(see WinMerge setup below for configuration)
425
		make inputs/<datasrc>/test by_col=1
426
			If you get errors this time, this always indicates a bug, usually in
427
				the VegBIEN unique constraints or column-based import itself
428
	Add newly-created files: make inputs/<datasrc>/add
429
	Commit: svn ci -m "Added inputs/<datasrc>/" inputs/<datasrc>/
430
	Update vegbiendev:
431 12396 aaronmk
		ssh aaronmk@jupiter.nceas.ucsb.edu
432 12998 aaronmk
			up
433 8458 aaronmk
		On local machine:
434
			./fix_perms
435
			make inputs/upload
436 10025 aaronmk
			make inputs/upload live=1
437 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
438 12998 aaronmk
			up
439 8458 aaronmk
			make inputs/download
440 10025 aaronmk
			make inputs/download live=1
441 8458 aaronmk
			Follow the steps under Install the staging tables above
442 1773 aaronmk
443 10884 aaronmk
Maintenance:
444
	on a live machine, you should put the following in your .profile:
445
--
446
# make svn files web-accessible. this does not affect unversioned files, because
447
# these get the right permissions on the local machine instead.
448
umask ug=rwx,o=rx
449
450
unset TMOUT # TMOUT causes screen to exit even with background processes
451
--
452
	if http://vegbiendev.nceas.ucsb.edu/phppgadmin/ goes down:
453 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
454 12548 aaronmk
			make phppgadmin-Linux
455 13027 aaronmk
	regularly, re-run full-database import so that bugs in it don't pile up.
456
		it needs to be kept in working order so that it works when it's needed.
457 13466 aaronmk
	to back up the vegbiendev databases:
458
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
459
		back up MySQL: # usually few changes, so do this first
460 14554 aaronmk
			backups/mysql_snapshot
461 13466 aaronmk
			l=1        overwrite=1 inplace=1 local_dir=/ remote_url="$USER@jupiter:/data/dev/aaronmk/Documents/BIEN/" subpath=/var/lib/mysql.bak/ sudo -E env PATH="$PATH" bin/sync_upload
462
			on local machine:
463
			l=1 swap=1 overwrite=1 inplace=1 local_dir=~ sync_remote_subdir=                          subpath=~/Documents/BIEN/var/lib/mysql.bak/                          bin/sync_upload
464
		back up Postgres:
465 14892 aaronmk
			$ screen
466
			# press Enter
467
			$ unset TMOUT # TMOUT causes shell to exit even with background processes
468 14894 aaronmk
			$ backups/pg_snapshot # runtime when queries have been run: 1 h ("64m11.586s")
469 10884 aaronmk
	to synchronize vegbiendev, jupiter, and your local machine:
470 12226 aaronmk
		**WARNING**: pay careful attention to all files that will be deleted or
471 10884 aaronmk
			overwritten!
472
		install put if needed:
473
			download https://uutils.googlecode.com/svn/trunk/bin/put to ~/bin/ and `chmod +x` it
474
		when changes are made on vegbiendev:
475 12951 aaronmk
			avoid extraneous diffs when rsyncing:
476 14670 aaronmk
				on local machine:
477
					up; ./fix_perms
478
				ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
479
					up; ./fix_perms
480
				ssh aaronmk@jupiter.nceas.ucsb.edu
481
					up; ./fix_perms
482 13284 aaronmk
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
483 12396 aaronmk
				upload:
484 14888 aaronmk
				del=1 bin/sync_upload --size-only
485 13337 aaronmk
					then review diff, and rerun with `l=1` prepended
486 12396 aaronmk
			on your machine:
487
				download:
488 14889 aaronmk
				overwrite=1 swap=1 src=. dest='aaronmk@jupiter.nceas.ucsb.edu:~/bien' put --exclude=.svn web/BIEN3/TWiki; ./fix_perms
489 13337 aaronmk
					then review diff, and rerun with `l=1` prepended
490 12957 aaronmk
				swap=1 bin/sync_upload backups/TNRS.backup
491 13337 aaronmk
					then review diff, and rerun with `l=1` prepended
492 14888 aaronmk
				del=1 swap=1 bin/sync_upload --size-only
493 13337 aaronmk
					then review diff, and rerun with `l=1` prepended
494 14891 aaronmk
				sync_remote_url=~/Dropbox/svn/ bin/sync_upload --existing --size-only --no-perms
495 14890 aaronmk
					# --size-only: just update mtimes
496
					# --no-perms: don't transfer the hardlink lock status
497 14891 aaronmk
					# no overwrite=1: preserve uncommitted changes
498 13337 aaronmk
					then review diff, and rerun with `l=1` prepended
499 12959 aaronmk
	to back up e-mails:
500
		on local machine:
501
		/Applications/gmvault-v1.8.1-beta/bin/gmvault sync --multiple-db-owner --type quick aaronmk.nceas@gmail.com
502
		open Thunderbird
503
		click the All Mail folder for each account and wait for it to download the e-mails in it
504
	to back up the version history:
505 13333 aaronmk
		# back up first on the local machine, because often only the svnsync
506
			command gets run, and that way it will get backed up immediately to
507
			Dropbox (and hourly to Time Machine), while vegbiendev only gets
508
			backed up daily to tape
509
		on local machine:
510 13331 aaronmk
		svnsync sync file://"$HOME"/Dropbox/docs/BIEN/svn_repo/ # initial runtime: 1.5 h ("08:21:38" - "06:45:26") @vegbiendev
511 12959 aaronmk
		(cd ~/Dropbox/docs/BIEN/git/; git svn fetch)
512 14565 aaronmk
		# use absolute path for vegbiendev commands because the Ubuntu 14.04
513
			version of rsync doesn't expand ~ properly
514 13332 aaronmk
		overwrite=1        src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:/data/dev/aaronmk/' put Dropbox/docs/BIEN/svn_repo/ # runtime: 1 min ("1:05.08")
515 13337 aaronmk
			then review diff, and rerun with `l=1` prepended
516 13332 aaronmk
		overwrite=1        src=~ dest='aaronmk@jupiter.nceas.ucsb.edu:/data/dev/aaronmk/' put Dropbox/docs/BIEN/git/
517 13337 aaronmk
			then review diff, and rerun with `l=1` prepended
518 14553 aaronmk
	to back up vegbiendev:
519 14568 aaronmk
		do steps under Maintenance > "to synchronize vegbiendev, jupiter, and
520
			your local machine"
521 14553 aaronmk
		on local machine:
522 14574 aaronmk
			l=1 overwrite=1 inplace=1 src=root@vegbiendev.nceas.ucsb.edu:/ dest=~/Documents/BIEN/vegbiendev/ sudo -E put --exclude=/var/lib/mysql.bak --exclude=/var/lib/postgresql.bak --exclude='/var/lib/postgresql/9.3/main/*/' --exclude=/home/aaronmk/bien
523 14601 aaronmk
			# enable --link-dest to work:
524
				chmod -R o+r ~/bien/.svn/; find ~/bien/.svn -type d -exec chmod o+rx {} \; # match perms
525
				l=1 overwrite=1 del= src='aaronmk@vegbiendev.nceas.ucsb.edu:~/bien/' dest=~/bien/ put --existing --size-only .svn/pristine/ # match times and perms
526
			l=1 overwrite=1 inplace=1 src=aaronmk@vegbiendev.nceas.ucsb.edu:/ dest=~/Documents/BIEN/vegbiendev/ sudo -E put --link-dest="$HOME"/Documents/BIEN/svn/ --no-owner --no-group home/aaronmk/bien/
527
				# --no-owner --no-group: needed to allow --link-dest to work
528
				# --link-dest: relative to dest, not currdir, so need abs path
529 14399 aaronmk
	to back up the local machine's settings:
530
		do step when changes are made on vegbiendev > on your machine, download
531
		ssh aaronmk@jupiter.nceas.ucsb.edu
532
			(cd ~/Dropbox/svn/; up)
533
		on your machine:
534 14549 aaronmk
			sudo find / -name .DS_Store -print -delete
535 14399 aaronmk
			rm ~/'Library/Thunderbird/Profiles/9oo8rcyn.default/ImapMail/imap.googlemail.com/[Gmail].sbd/Spam'
536
				# remove the downloaded Spam folder, because spam e-mails often contain viruses that would trigger clamscan
537 14548 aaronmk
			overwrite=1           sync_local_dir=~/Dropbox/svn/ sync_remote_subdir=Dropbox/svn/ bin/sync_upload --size-only # just update mtimes
538 14399 aaronmk
				then review diff, and rerun with `l=1` prepended
539 14738 aaronmk
			overwrite=1 inplace=1 sync_local_dir=~/             sync_remote_subdir=             bin/sync_upload ~/"VirtualBox VMs/**" # need inplace=1 because they are very large files
540 14399 aaronmk
				then review diff, and rerun with `l=1` prepended
541 14738 aaronmk
			overwrite=1           sync_local_dir=~/             sync_remote_subdir= sudo -E     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" --exclude="/software/**/.svn/"
542 14693 aaronmk
				# sudo -E: needed for Documents/BIEN/vegbiendev*/
543 14399 aaronmk
				then review diff, and rerun with `l=1` prepended
544 14692 aaronmk
			pause Dropbox: system tray > Dropbox icon > gear icon > Pause Syncing
545 14399 aaronmk
				this prevents Dropbox from trying to capture filesystem
546
				events while syncing
547 14738 aaronmk
			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=/gmvault-db/ --exclude="/software/" --exclude="/VirtualBox VMs/**.sav" --exclude="/VirtualBox VMs/**.vdi" --exclude="/VirtualBox VMs/**.vmdk"
548 14399 aaronmk
				then review diff, and rerun with `l=1` prepended
549 14692 aaronmk
			resume Dropbox: system tray > Dropbox icon > gear icon > Resume Syncing
550 10884 aaronmk
	to backup files not in Time Machine:
551 14667 aaronmk
		**IMPORTANT**: need to use 2 TB external hard drive instead of Time
552
			Machine drive because Time Machine drive does not have
553
			~/Documents/BIEN/ in a location where it can be hardlinked against
554 11516 aaronmk
		On local machine:
555 14656 aaronmk
		on first run, create parent dirs:
556 14667 aaronmk
			sudo mkdir -p '/Volumes/BIEN3.**SAVE**/Users/aaronmk/Documents/BIEN/'
557
			sudo mkdir -p '/Volumes/BIEN3.**SAVE**/usr/local/var/postgres/'
558
			l=1 src=/ dest='/Volumes/BIEN3.**SAVE**/' sudo -E put --existing
559
		l=1 overwrite=1 src=/ dest='/Volumes/BIEN3.**SAVE**/' sudo -E put --include='/vegbiendev**' --exclude='**' Users/aaronmk/Documents/BIEN/
560 14660 aaronmk
			# this cannot be backed up by Time Machine because it dereferences hard links:
561
			#  `sudo find /Volumes/Time\ Machine\ Backups/Backups.backupdb/ ! -type d -links +1`
562
			#  returns no files when there is a single timestamped backup, but
563
			#  `sudo find / ! -type d -links +1` does
564 14667 aaronmk
		l=1 overwrite=1 src=/ dest='/Volumes/BIEN3.**SAVE**/' sudo -E put usr/local/var/postgres/
565 14655 aaronmk
			# this cannot be backed up by Time Machine because it prevents the backup process from ending
566 13797 aaronmk
		launchctl unload ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist # stop the PostgreSQL server
567 14667 aaronmk
		l=1 overwrite=1 src=/ dest='/Volumes/BIEN3.**SAVE**/' sudo -E put usr/local/var/postgres/
568 13797 aaronmk
		launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist # start the PostgreSQL server
569 14400 aaronmk
	to back up the local machine's hard drive:
570
		turn on and connect the 2 TB external hard drive
571 14608 aaronmk
		screen
572 14623 aaronmk
		# --exclude='/\**': exclude *-files indicating the (differing) retention
573
		#  statuses of the partitions involved
574 14692 aaronmk
		pause Dropbox: system tray > Dropbox icon > gear icon > Pause Syncing
575 14550 aaronmk
			otherwise, the backup of ~/.dropbox will be corrupted
576 14551 aaronmk
		launchctl unload ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist # stop the PostgreSQL server
577 14627 aaronmk
		l=1 overwrite=1 src=/ dest='/Volumes/BIEN3.**SAVE**/' sudo -E put --exclude='/\**' --exclude=/.fseventsd/ --exclude=/private/var/vm/
578 14696 aaronmk
			# no --extended-attributes: rsync has to visit every file for this
579
			# runtime: 10 min (~600); initial runtime: 4-13 h ("2422.84"+"12379.91" .. "45813.19"+"747.96")
580 14551 aaronmk
		launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist # start the PostgreSQL server
581 14692 aaronmk
		resume Dropbox: system tray > Dropbox icon > gear icon > Resume Syncing
582 14401 aaronmk
	to restore from Time Machine:
583
		# restart holding Alt
584
		# select Time Machine Backups
585
		# restore the last Time Machine backup to Macintosh HD
586
		# restart holding Alt
587
		# select Macintosh HD
588
		$ screen
589 14607 aaronmk
		$ l=1 swap=1 src=/ dest=/Volumes/Time\ Machine\ Backups/ sudo -E put usr/local/var/postgres/ # runtime: 1 h ("4020.61")
590 14401 aaronmk
		$ make postgres_restart
591 10884 aaronmk
	VegCore data dictionary:
592
		Regularly, or whenever the VegCore data dictionary page
593
			(https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/VegCore)
594
			is changed, regenerate mappings/VegCore.csv:
595 11516 aaronmk
			On local machine:
596 10884 aaronmk
			make mappings/VegCore.htm-remake; make mappings/
597 12716 aaronmk
			apply new data dict mappings to datasource mappings/staging tables:
598 12883 aaronmk
				inputs/run postprocess # runtime: see inputs/run
599 12887 aaronmk
				time yes|make inputs/{NVS,SALVIAS,TEAM}/test # old-style import; runtime: 1 min ("0m59.692s") @starscream
600 10884 aaronmk
			svn di mappings/VegCore.tables.redmine
601
			If there are changes, update the data dictionary's Tables section
602
			When moving terms, check that no terms were lost: svn di
603
			svn ci -m 'mappings/VegCore.htm: regenerated from wiki'
604 13284 aaronmk
			ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
605 12717 aaronmk
				perform the steps under "apply new data dict mappings to
606
					datasource mappings/staging tables" above
607 10884 aaronmk
	Important: Whenever you install a system update that affects PostgreSQL or
608
		any of its dependencies, such as libc, you should restart the PostgreSQL
609
		server. Otherwise, you may get strange errors like "the database system
610
		is in recovery mode" which go away upon reimport, or you may not be able
611
		to access the database as the postgres superuser. This applies to both
612
		Linux and Mac OS X.
613
614
Backups:
615
	Archived imports:
616 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
617 10884 aaronmk
		Back up: make backups/<version>.backup &
618
			Note: To back up the last import, you must archive it first:
619
				make schemas/rotate
620
		Test: make -s backups/<version>.backup/test &
621
		Restore: make backups/<version>.backup/restore &
622
		Remove: make backups/<version>.backup/remove
623
		Download: make backups/<version>.backup/download
624
	TNRS cache:
625 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
626 10884 aaronmk
		Back up: make backups/TNRS.backup-remake &
627
			runtime: 3 min ("real 2m48.859s")
628
		Restore:
629
			yes|make inputs/.TNRS/uninstall
630
			make backups/TNRS.backup/restore &
631
				runtime: 5.5 min ("real 5m35.829s")
632
			yes|make schemas/public/reinstall
633
				Must come after TNRS restore to recreate tnrs_input_name view
634
	Full DB:
635 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
636 10884 aaronmk
		Back up: make backups/vegbien.<version>.backup &
637
		Test: make -s backups/vegbien.<version>.backup/test &
638
		Restore: make backups/vegbien.<version>.backup/restore &
639
		Download: make backups/vegbien.<version>.backup/download
640
	Import logs:
641 11516 aaronmk
		On local machine:
642 10884 aaronmk
		Download: make inputs/download-logs live=1
643
644 6484 aaronmk
Datasource refreshing:
645 8458 aaronmk
	VegBank:
646 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
647 8458 aaronmk
		make inputs/VegBank/vegbank.sql-remake
648
		make inputs/VegBank/reinstall quiet=1 &
649 6484 aaronmk
650 702 aaronmk
Schema changes:
651 11516 aaronmk
	On local machine:
652 8458 aaronmk
	When changing the analytical views, run sync_analytical_..._to_view()
653
		to update the corresponding table
654
	Remember to update the following files with any renamings:
655
		schemas/filter_ERD.csv
656
		mappings/VegCore-VegBIEN.csv
657
		mappings/verify.*.sql
658
	Regenerate schema from installed DB: make schemas/remake
659
	Reinstall DB from schema: make schemas/public/reinstall schemas/reinstall
660 12226 aaronmk
		**WARNING**: This will delete the public schema of your VegBIEN DB!
661 12227 aaronmk
	If needed, reinstall staging tables:
662 8837 aaronmk
		On local machine:
663 8840 aaronmk
			sudo -E -u postgres psql <<<'ALTER DATABASE vegbien RENAME TO vegbien_prev'
664 8845 aaronmk
			make db
665 8837 aaronmk
			. bin/reinstall_all
666
			Fix any bugs and retry until no errors
667 8846 aaronmk
			make schemas/public/install
668
				This must be run *after* the datasources are installed, because
669
				views in public depend on some of the datasources
670 8842 aaronmk
			sudo -E -u postgres psql <<<'DROP DATABASE vegbien_prev'
671 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
672 12396 aaronmk
			repeat the above steps
673 12226 aaronmk
			**WARNING**: Do not run this until reinstall_all runs successfully
674
			on the local machine, or the live DB may be unrestorable!
675 12927 aaronmk
	update mappings and staging table column names:
676 12881 aaronmk
		on local machine:
677 12883 aaronmk
			inputs/run postprocess # runtime: see inputs/run
678 12887 aaronmk
			time yes|make inputs/{NVS,SALVIAS,TEAM}/test # old-style import; runtime: 1 min ("0m59.692s") @starscream
679 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
680 12928 aaronmk
			manually apply schema changes to the live public schema
681 12929 aaronmk
			do steps under "on local machine" above
682 8458 aaronmk
	Sync ERD with vegbien.sql schema:
683
		Run make schemas/vegbien.my.sql
684
		Open schemas/vegbien.ERD.mwb in MySQLWorkbench
685
		Go to File > Export > Synchronize With SQL CREATE Script...
686
		For Input File, select schemas/vegbien.my.sql
687
		Click Continue
688
		In the changes list, select each table with an arrow next to it
689
		Click Update Model
690
		Click Continue
691
		Note: The generated SQL script will be empty because we are syncing in
692
			the opposite direction
693
		Click Execute
694
		Reposition any lines that have been reset
695
		Add any new tables by dragging them from the Catalog in the left sidebar
696
			to the diagram
697
		Remove any deleted tables by right-clicking the table's diagram element,
698
			selecting Delete '<table name>', and clicking Delete
699
		Save
700
		If desired, update the graphical ERD exports (see below)
701
	Update graphical ERD exports:
702
		Go to File > Export > Export as PNG...
703
		Select schemas/vegbien.ERD.png and click Save
704
		Go to File > Export > Export as SVG...
705
		Select schemas/vegbien.ERD.svg and click Save
706
		Go to File > Export > Export as Single Page PDF...
707
		Select schemas/vegbien.ERD.1_pg.pdf and click Save
708
		Go to File > Print...
709
		In the lower left corner, click PDF > Save as PDF...
710
		Set the Title and Author to ""
711
		Select schemas/vegbien.ERD.pdf and click Save
712
		Commit: svn ci -m "schemas/vegbien.ERD.mwb: Regenerated exports"
713
	Refactoring tips:
714
		To rename a table:
715
			In vegbien.sql, do the following:
716
				Replace regexp (?<=_|\b)<old>(?=_|\b) with <new>
717
					This is necessary because the table name is *everywhere*
718
				Search for <new>
719
				Manually change back any replacements inside comments
720
		To rename a column:
721
			Rename the column: ALTER TABLE <table> RENAME <old> TO <new>;
722
			Recreate any foreign key for the column, removing CONSTRAINT <name>
723
				This resets the foreign key name using the new column name
724
	Creating a poster of the ERD:
725
		Determine the poster size:
726
			Measure the line height (from the bottom of one line to the bottom
727
				of another): 16.3cm/24 lines = 0.679cm
728
			Measure the height of the ERD: 35.4cm*2 = 70.8cm
729
			Zoom in as far as possible
730
			Measure the height of a capital letter: 3.5mm
731
			Measure the line height: 8.5mm
732
			Calculate the text's fraction of the line height: 3.5mm/8.5mm = 0.41
733
			Calculate the text height: 0.679cm*0.41 = 0.28cm
734
			Calculate the text height's fraction of the ERD height:
735
				0.28cm/70.8cm = 0.0040
736
			Measure the text height on the *VegBank* ERD poster: 5.5mm = 0.55cm
737
			Calculate the VegBIEN poster height to make the text the same size:
738
				0.55cm/0.0040 = 137.5cm H; *1in/2.54cm = 54.1in H
739
			The ERD aspect ratio is 11 in W x (2*8.5in H) = 11x17 portrait
740
			Calculate the VegBIEN poster width: 54.1in H*11W/17H = 35.0in W
741
			The minimum VegBIEN poster size is 35x54in portrait
742
		Determine the cost:
743
			The FedEx Kinkos near NCEAS (1030 State St, Santa Barbara, CA 93101)
744
				charges the following for posters:
745
				base: $7.25/sq ft
746
				lamination: $3/sq ft
747
				mounting on a board: $8/sq ft
748 203 aaronmk
749 1459 aaronmk
Testing:
750 8458 aaronmk
	On a development machine, you should put the following in your .profile:
751 8469 aaronmk
		umask ug=rwx,o= # prevent files from becoming web-accessible
752 8458 aaronmk
		export log= n=2
753 11985 aaronmk
	For development machine specs, see /planning/resources/dev_machine.specs/
754 11516 aaronmk
	On local machine:
755 8458 aaronmk
	Mapping process: make test
756
		Including column-based import: make test by_col=1
757
			If the row-based and column-based imports produce different inserted
758
			row counts, this usually means that a table is underconstrained
759
			(the unique indexes don't cover all possible rows).
760
			This can occur if you didn't use COALESCE(field, null_value) around
761
			a nullable field in a unique index. See sql_gen.null_sentinels for
762
			the appropriate null value to use.
763
	Map spreadsheet generation: make remake
764
	Missing mappings: make missing_mappings
765
	Everything (for most complete coverage): make test-all
766 702 aaronmk
767 7183 aaronmk
Debugging:
768 8458 aaronmk
	"Binary chop" debugging:
769
		(This is primarily useful for regressions that occurred in a previous
770
		revision, which was committed without running all the tests)
771 12998 aaronmk
		up -r <rev>; make inputs/.TNRS/reinstall; make schemas/public/reinstall; make <failed-test>.xml
772 8470 aaronmk
	.htaccess:
773
		mod_rewrite:
774 12226 aaronmk
			**IMPORTANT**: whenever you change the DirectorySlash setting for a
775 8471 aaronmk
				directory, you *must* clear your browser's cache to ensure that
776
				a cached redirect is not used. this is because RewriteRule
777
				redirects are (by default) temporary, but DirectorySlash
778
				redirects are permanent.
779 8470 aaronmk
				for Firefox:
780
					press Cmd+Shift+Delete
781
					check only Cache
782
					press Enter or click Clear Now
783 7183 aaronmk
784 3783 aaronmk
WinMerge setup:
785 11516 aaronmk
	In a Windows VM:
786 8458 aaronmk
	Install WinMerge from <http://winmerge.org/>
787
	Open WinMerge
788
	Go to Edit > Options and click Compare in the left sidebar
789
	Enable "Moved block detection", as described at
790
		<http://manual.winmerge.org/Configuration.html#d0e5892>.
791
	Set Whitespace to Ignore change, as described at
792
		<http://manual.winmerge.org/Configuration.html#d0e5758>.
793 3783 aaronmk
794 3133 aaronmk
Documentation:
795 8458 aaronmk
	To generate a Redmine-formatted list of steps for column-based import:
796 11516 aaronmk
		On local machine:
797 8458 aaronmk
		make schemas/public/reinstall
798
		make inputs/ACAD/Specimen/logs/steps.by_col.log.sql
799
	To import and scrub just the test taxonomic names:
800 13284 aaronmk
		ssh -t vegbiendev.nceas.ucsb.edu exec sudo -u aaronmk -i
801 8458 aaronmk
		inputs/test_taxonomic_names/test_scrub
802 3133 aaronmk
803 702 aaronmk
General:
804 8458 aaronmk
	To see a program's description, read its top-of-file comment
805
	To see a program's usage, run it without arguments
806
	To remake a directory: make <dir>/remake
807
	To remake a file: make <file>-remake