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