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