Project

General

Profile

1 702 aaronmk
Installation:
2
    Install: make install
3 1967 aaronmk
        WARNING: This will delete any existing VegBIEN DB!
4 702 aaronmk
    Uninstall: make uninstall
5 1749 aaronmk
        WARNING: This will delete your VegBIEN DB!
6 1957 aaronmk
    Reinstall all datasources at once: . bin/reinstall_all
7 554 aaronmk
8 702 aaronmk
Data import:
9 1550 aaronmk
    Import data into VegBIEN: . bin/import_all
10 3205 aaronmk
        Using column-based import: . bin/with_all 'import by_col=1'
11 1556 aaronmk
    Stop all running imports: . bin/stop_imports
12 2976 aaronmk
    Archive the last import: make schemas/rotate
13
    Re-import data: make schemas/rotate; . bin/import_all
14
        Note: This will archive the last import.
15
    Empty the DB: make schemas/reinstall
16 1749 aaronmk
        WARNING: This will delete your VegBIEN DB!
17 554 aaronmk
18 1773 aaronmk
Datasource setup:
19
    Add a new datasource: make inputs/<short_name>/add
20
        If the datasource is a herbarium, <short_name> should be the herbarium
21
        code as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
22
23 702 aaronmk
Schema changes:
24
    Regenerate schema from installed DB: make schemas/remake
25 1967 aaronmk
    Reinstall DB from schema: make schemas/reinstall
26 1750 aaronmk
        WARNING: This will delete your VegBIEN DB!
27 702 aaronmk
    Sync ERD with vegbien.sql schema:
28
        Run make schemas/vegbien.my.sql
29
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
30
        Go to File > Export > Synchronize With SQL CREATE Script...
31
        For Input File, select schemas/vegbien.my.sql
32
        Click Continue
33
        Click in the changes list and press Ctrl+A or Apple+A to select all
34
        Click Update Model
35
        Click Continue
36
        Note: The generated SQL script will be empty because we are syncing in
37
            the opposite direction
38
        Click Execute
39
        Reposition any lines that have been reset
40
        Add any new tables by dragging them from the Catalog in the left sidebar
41
            to the diagram
42
        Remove any deleted tables by right-clicking the table's diagram element,
43
            selecting Delete '<table name>', and clicking Delete
44
        Save
45 1774 aaronmk
        If desired, update the graphical ERD exports (see below)
46
    Update graphical ERD exports:
47 702 aaronmk
        Go to File > Export > Export as PNG...
48 1774 aaronmk
        Select schemas/vegbien.ERD.png and click Save
49 702 aaronmk
        Go to File > Export > Export as SVG...
50 1774 aaronmk
        Select schemas/vegbien.ERD.svg and click Save
51 702 aaronmk
        Go to File > Export > Export as Single Page PDF...
52 1774 aaronmk
        Select schemas/vegbien.ERD.pdf and click Save
53
        Go to File > Print...
54
        For Pages, choose From 1 To 1
55
        In the lower left corner, click PDF > Save as PDF...
56
        Set the Title and Author to ""
57
        Select schemas/vegbien.ERD.core.pdf and click Save
58 203 aaronmk
59 1459 aaronmk
Testing:
60
    Mapping process: make test
61
    Map spreadsheet generation: make remake
62 1744 aaronmk
    Missing mappings: make missing_mappings
63 1459 aaronmk
    Everything (for most complete coverage): make test-all
64 702 aaronmk
65 3133 aaronmk
Documentation:
66
    To generate a Redmine-formatted list of steps for column-based import:
67
        make inputs/QMOR/import/steps.by_col.sql
68
69 702 aaronmk
General:
70
    To see a program's description, read its top-of-file comment
71
    To see a program's usage, run it without arguments