Commit 266e6e5a authored by Stuart Sides's avatar Stuart Sides Committed by Laura, Jason R
Browse files

Updated Test Data Obtaining, Maintaining, and Submitting (markdown)

parent 3edab54a
Loading
Loading
Loading
Loading
+7 −14
Original line number Diff line number Diff line
@@ -13,17 +13,15 @@ In order to run existing tests and develop new tests a full development environm
1) Download the ISIS data files see the [Full ISIS3 Data Download](https://gith**ub.com/USGS-Astrogeology/ISIS3). NOTE: Be careful where you put the ISISDATA area. It is several hundred GB and growing.**

## Downloading Test Data
ISIS unit and regression tests require the data and test data directories to be available and their respective environment variables (ISISDATA, ISIS3TESTDATA) be set. This allows the tests to read files from these areas and compare results to known truth data. The ISIS tests data is currently distributed using rsync servers. NOTE: Work is underway to put the test data under full version control in a Git repository. From a terminal window set your current working directory to where you want the test data to be downloaded to, and use the rsync command below to copy it to your computer.
ISIS unit and regression tests require the data and test data directories to be available and their respective environment variables (ISISDATA, ISIS3TESTDATA) be set. This allows the tests to read files from these areas and compare results to known truth data. The ISIS tests data is currently distributed using rsync servers, but work is underway to put the test data under full version control in a Git repository. To download all of the test data, use a terminal window, set your current working directory to where you want the test data to be stored, and use the rsync command below to copy it to your computer:

**Note: Be extremely careful using the suggested --delete option with the rsync command below. If the destination directory is not correct this command can delete all files at that location.**
```
# **Note: Be extremely careful using the suggested --delete option with the rsync command below. **
**# If the destination directory is not correct this command can delete all files at that location.**
**cd /where/you/want/to/locate/the/test/data**
rsync -azv --partial --delete isisdist.astrogeology.usgs.gov::isis3testData .
```
When the rsync command is finished, there should be a single directory called "isis" containing about 80GB. The directory structure below this "isis" directory is required to be identical to the ISIS source code directory structure.

The environment variable "ISIS3TESTDATA" needs to be be set to point to this "isis" directory. Note: Each of the examples below ends with an "isis" directory.
The environment variable "ISIS3TESTDATA" needs to be be set to point to the "isis" directory created by the rsync command above. Note: Each of the examples below ends with an "isis" directory.

Bash and other sh based shells:
```
@@ -32,15 +30,6 @@ export ISIS3TESTDATA=/path/to/the/test/data/for/isis
tcsh or other csh based shells:
setenv ISIS3TESTDATA /path/to/the/test/data/for/isis


## Where to go now
* Running tests (https://github.com/USGS-Astrogeology/ISIS3/wiki/Developing-ISIS3-with-cmake#running-tests)
* Writing Unit Tests (https://github.com/USGS-Astrogeology/ISIS3/wiki/Developing-ISIS3-with-cmake#running-tests)
* Writing Application and Module Tests (https://github.com/USGS-Astrogeology/ISIS3/wiki/Developing-ISIS3-with-cmake#running-tests)
* Contributing New/Modified Test Data (link)



# Contributing New and Modified Tests Data
The source code for the unit and regression tests is located with the ISIS source code repository on Github, but the data used by the tests is currently internal to USGS. Is it made available through the read-only rsync servers. Use the following command to download the current version of of the test data:
**NOTE: Be very careful using the --delete argument below. If there are existing files in the destination folder that are not in the test data download they will be deleted.**
@@ -52,3 +41,7 @@ Efforts are underway to make all of the test data available in a publicly access

If you are writing or modifying ISIS library classes or applications it is required they be well tested. This may include modifications to existing test data and/or new test data. Once a GitHub pull request has been created for ISIS source code changes the data needs to be made available to USGS personnel through a web or ftp link. If this is not an option for you, please contact the USGS through the [discussion forum](https://astrodiscuss.usgs.gov/) and we can make other arrangements.

## Where to go now
* Running tests (https://github.com/USGS-Astrogeology/ISIS3/wiki/Developing-ISIS3-with-cmake#running-tests)
* Writing Unit Tests (https://github.com/USGS-Astrogeology/ISIS3/wiki/Developing-ISIS3-with-cmake#running-tests)
* Writing Application and Module Tests (https://github.com/USGS-Astrogeology/ISIS3/wiki/Developing-ISIS3-with-cmake#running-tests)