@@ -153,6 +153,13 @@ To build the user's guide::
153
153
This will build HTML and PDF documentation, writing them to ``dist/userguide ``
154
154
and ``dist/InVEST_*_Documentation.pdf ``, respectively.
155
155
156
+ The User's Guide is maintained in a separate git reporsitory. InVEST will build
157
+ the User's Guide with the commit defined in the ``Makefile ``::
158
+
159
+ GIT_UG_REPO := https://github.com/natcap/invest.users-guide
160
+ GIT_UG_REPO_PATH := doc/users-guide
161
+ GIT_UG_REPO_REV := f203ec069f9f03560c9a85b268e67ebb6b994953
162
+
156
163
157
164
API Documentation
158
165
+++++++++++++++++
@@ -176,22 +183,12 @@ build zip archives of the sample data::
176
183
177
184
This will write the data zipfiles to ``dist/data ``. ``git `` command is needed.
178
185
179
- Single archive of sample data
180
- +++++++++++++++++++++++++++++
181
-
182
- For trainings, it is especially convenient to distribute all sample data as a
183
- single zip archive. As an added bonus, this single zip archive can be provided
184
- to the InVEST installer for Windows as either the 'Advanced' input on the front
185
- page of the installer, or by a CLI flag, thus preventing the installer from
186
- downloading datasets from the internet. See
187
- ``installer/windows/invest_installer.nsi `` for more details. To build a single
188
- archive of all InVEST sample data::
189
-
190
- $ make sampledata_single
191
-
192
- This will write the single sampledata archive to
193
- ``dist/InVEST_*_sample_data.zip ``.
186
+ Sample data is tracked in a ``git-lfs `` repo and will be packaged based on the commit
187
+ defined in the ``Makefile ``::
194
188
189
+ GIT_SAMPLE_DATA_REPO := https://bitbucket.org/natcap/invest-sample-data.git
190
+ GIT_SAMPLE_DATA_REPO_PATH := $(DATA_DIR)/invest-sample-data
191
+ GIT_SAMPLE_DATA_REPO_REV := 0f8b41557753dad3670ba8220f41650b51435a93
195
192
196
193
Tests
197
194
-----
@@ -205,6 +202,16 @@ To run tests on the suite of Ecosystem Service models in InVEST::
205
202
206
203
$ make test
207
204
205
+ Tests depend on test data that is tracked in a ``git-lfs `` repo defined in the ``Makefile ``::
206
+
207
+ GIT_TEST_DATA_REPO := https://bitbucket.org/natcap/invest-test-data.git
208
+ GIT_TEST_DATA_REPO_PATH := $(DATA_DIR)/invest-test-data
209
+ GIT_TEST_DATA_REPO_REV := 324abde73e1d770ad75921466ecafd1ec6297752
210
+
211
+ Test data (and Sample Data) can be retrieved using::
212
+
213
+ $ make fetch
214
+
208
215
209
216
Changing how GNU make runs tests
210
217
++++++++++++++++++++++++++++++++
0 commit comments