4. Running rsudp

After modifying the settings file to your liking, you are ready to start rsudp.

4.1. Starting rsudp on Unix

Unix users may prefer to start with the easy-to-use start script available in the git repository:

bash unix-start-rsudp.sh

4.2. Starting rsudp on Windows

After modifying the settings file, Windows users can double click on the batch file named win-start-rsudp.bat to start.

4.3. Starting manually on Windows or Unix

This start method is covered in our rsudp start/run tutorial video.

1. First, to activate the conda environment, type conda activate rsudp. If you can’t do this, and you’re on Unix, you may need to Run the sourcing line.

2. Next, configure a datacast stream (formerly known as a UDP stream) to forward data to an open port on the computer where this program is running. By default this port is 8888.

3. The UNIX installer will create a settings file in $HOME/.config/rsudp/rsudp_settings.json. Change the settings in this file to control how the client operates.

Note

Windows users will need to type rs-client -d default to dump the settings to a file the first time they run this program.

Note

To dump the default settings to a different location of your choosing, type rs-client -d /path/to/settings.json.

Note

As stated above, to rebuild and overwrite the default settings file in $HOME/.config/rsudp/rsudp_settings.json, type rs-client -d default

4. After modifying the settings file to your liking, type rs-client to use the settings file at $HOME/.config/rsudp/rsudp_settings.json, or rs-client -s /path/to/settings.json to run with a settings file other than the default one.

Note

This library can only handle incoming data from one Shake per port. If for some reason more than one Shake is sending data to the port, the software will only process data coming from the IP of the first Shake it sees sending data. All data coming from any other Shake(s) will be ignored.

4.4. Running in demonstration/testing mode

See more about this functionality in Testing and demoing rsudp.

To start, open a Terminal or Anaconda Prompt window.

1. Activate the conda environment by typing conda activate rsudp.
2. Type rs-test and press enter.

Test data will begin flowing through the program. Several features will be tested, including the earthquake detection functionality, the alarm sound, and the plot.

4.5. Quitting

You can force-stop rsudp in all operating systems by either closing the plot window (if open) or by pressing Ctrl+C with the terminal window in focus.

Back to top ↑