Description
ROVER is a command line tool to robustly retrieve geophysical timeseries data from data centers such as EarthScope. It builds an associated index for downloaded data to generate a local repository. ROVER compares a built local index to timeseries availability information provided by the datacenter. This enables a local archive to remain synchronized with a remote data center.
Documentation
- Installation
- Quick start
- ROVER commands
- ROVER configuration
- Example commands to download data
- Example commands to manage and maintain the local store
- ROVER’s change log
- ROVER’s processing pipeline
- Known bugs and limitations
- ROVER development
Installation
ROVER is a command-line tool that requires Python 2.7, 3.6.2 or a later. Python 3.7 or above running on Linux or macOS are known to work best (pre-installed versions of Python available on some operating systems, such as macOS, may not support ROVER installation or operation without additional work). We suggest installing Miniconda 3 (or the full Anaconda if you wish) for the best results.
Option 1
ROVER requires the C
language program mseedindex be available on the system’s path. A C
compiler and the make
program are required to build mseedindex. ROVER and mseedindex may be downloaded and compiled simultaneously using pip:
pip install rover[mseedindex]
Option 2
Alternatively, ROVER and mseedindex may be installed independently.
mseedindex may be downloaded and compiled following the mseedindex install guidelines. Similar to installation option 1, building mseedindex is dependent upon the make
program and a C
compiler.
Once mseedindex is configured and availble on the system’s path, use pip
to install ROVER and its other Python requirements:
pip install rover
You should now be able to type rover --version
to see if it was successfully installed.
Quick start
Initialize a data repository, which creates the datarepo
directory, and change into the new directory:
rover init-repository datarepo
cd datarepo
Create a request file named request.txt
containing:
IU ANMO * LHZ 2012-01-01T00:00:00 2012-02-01T00:00:00
TA MSTX -- BH? 2012-01-01T00:00:00 2012-02-01T00:00:00
Run the process rover retrieve
to fetch these data:
rover retrieve request.txt
list-summary
prints the retrieved data from the earliest to the latest timespans:
rover list-summary
IU_ANMO_00_LHZ 2012-01-01T00:00:00.069500 2012-01-31T23:59:59.069500
IU_ANMO_10_LHZ 2012-01-01T00:00:00.069500 2012-01-31T23:59:59.069500
TA_MSTX__BHE 2012-01-01T00:00:00.000000 2012-01-31T23:59:59.975000
TA_MSTX__BHN 2012-01-01T00:00:00.000000 2012-01-31T23:59:59.975000
TA_MSTX__BHZ 2012-01-01T00:00:00.000000 2012-01-31T23:59:59.975000
Retrieved files are miniSEED format containing day lengths of station data. The files are saved with the path structure:
<datarepo>/data/<network>/<year>/<day>/<station>.<network>.<year>.<day>
Exploring ROVER
ROVER has built-in help. The command rover help
prints a ROVER introduction to the terminal.
There are many more options available in ROVER including; the ability to send emails that monitor
ROVER request and subscriptions (see the --email
option), view listings of contiguous traces (via the rover list-index join
command), or view the status of a long-running download using a web browser (by default at http://localhost:8000/).rover help help
prints a list of commands available in the ROVER code suite.
ROVER is configurable via the rover.config file or by using the command line. Type rover -h
to see the configuration parameters that are adjustable using the command line.
For more detailed examples, see more example commands to download data and example commands to manage and maintain the local repository.
Copyright and License
ROVER is a EarthScope product.
It is free software and can be redistributed and/or modified under the terms of the GNU General Public License, version 3 or later, as published by the Free Software Foundation.
ROVER is distributed without any warranty including the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.
A copy of the GNU General Public License should be included with the ROVER package. If not, see http://www.gnu.org/licenses/.
Copyright (c) 2018 EarthScope Consortium