Project

General

Profile

« Previous | Next » 

Revision 11562

Added notes on running biengeo scripts to README.

View differences:

derived/biengeo/README.txt
3 3

  
4 4
***** obtain source code:
5 5
svn co https://code.nceas.ucsb.edu/code/projects/bien/derived/biengeo/
6
additional, in-progress files are at
7
sftp://vegbiendev.nceas.ucsb.edu/home/psarando/src/bien/derived/biengeo/
8 6

  
9 7
***** install dependencies:
10 8
The only dependencies for running these scripts are PostgreSQL 9.1, postgis 2.0,
......
23 21
sudo apt-get install postgresql-9.1-postgis-2.0-scripts
24 22

  
25 23

  
24
***** Notes on running the shell scripts:
25
Running any script with the -? or --help option will print a usage message with
26
all available options for that script, and then exit.
27

  
28
The following scripts accept database connection options, similar to psql.
29
For example: setup.sh -d dbname -h hostname -U username
30
The defaults passed to psql commands, if no options are given to the shell
31
scripts, are 'geoscrub' for dbname and 'bien' for username. The -h option is
32
not passed to psql commands by default.
33

  
34
The update_validation_data.sh scripts will only download fresh validation data
35
if the directories for GADM data (~/gadm_v2_shp by default) and geonames.org
36
data (~/geonames by default) do not already exist or do not contain that data.
37

  
38
The geoscrub scripts will only download fresh input data if the directory for
39
the input data (~/geoscrub_input by default) does not already exist or does not
40
contain the geoscrub-corpus.csv input file.
41

  
26 42
***** initialize the DB:
27 43
cd <svn_biengeo_root>
28 44
1. setup.sh
......
31 47
***** update geoscrub validation data:
32 48
runtime: ~40 minutes
33 49
cd <svn_biengeo_root>
34
2. update_validation_data.sh
50
2. update_validation_data.sh [--gadm-data=gadm_dir] [--geonames-data=geonames_dir]
35 51
   - runs the following scripts in order to load validation data:
36 52
   * update_gadm_data.sh
37 53
     runtime: ~15 minutes (not including download time)
......
48 64
WARNING: deletes any previous geoscrubbing results!
49 65
runtime: ~5.5 h
50 66
cd <svn_biengeo_root>
51
3. geoscrub.sh
67
3. geoscrub.sh [--geoscrub-input=input_dir]
52 68
   - runs the following scripts in order to load and scrub vegbien input data:
53 69
   * load-geoscrub-input.sh
54 70
     - dumps geoscrub_input from vegbien and loads it into the geoscrub db

Also available in: Unified diff