Gsof2Ring

A python module that uses PyEarthworm Library to inject RTX GSOF Messages into an Earthworm Ring

Installation & Configuration

This module already assumes Earthworm, Anaconda Python, and PyEarthworm are already installed and configured and with the same bit-size (32 or 64 bits). A copy of it is included in the git repo as as submodule run:

git submodule init
git submodule update

to fetch relevant files. To install and run:

1. Download or clone the repository in an place accessible to executables for the user that runs earthworm.
2. Move the compiled PyEW shared library into the Gsof2Ring folder.
3. In startstop_*.d add the command 'Gsof2Ring.sh' with the following parameters:
   1. -p: Configuration file

The resulting commandline command should look like this:

Gsof2Ring.sh -p <Path to config file>

Gsof2Ring.d configuration file

Unlike normal Earthworm modules, Gsof2Ring has a simpler type of configuration file. It has three major sections:

1. Earthworm: Contains EW Related INFO
   1. RING_ID: The integer that has the Ring ID
   2. MOD_ID: The integer that has the Module ID
   3. INST_ID: The integer tha belongs to the Installation ID
2. Station
   1. IP: The IP of the GSOF Station
   2. PORT: The port of the GSOF protocol
   3. NAME: The name of the GSOF station
   4. NETWORK: The network of the station
3. GPS
   1. X: The X reference coordinate
   2. Y: The Y reference coordinate
   3. Z: The Z reference coordinate
   4. CHX: The channel name for the X position
   5. CHY: The channel name for the Y position
   6. CHZ: The channel name for the Z position
   7. LEAP_SECONDS: The current number of GPS Leap Seconds

The following is an example of a configuration file (usually named gsof2ring.d):

[Earthworm]
RING_ID: 1000
MOD_ID: 8
INST_ID: 141
HB: 30

[Station]
IP: 127.0.0.1
PORT: 10000
NAME: PRSN
NETWORK: PR

[GPS]
X: 2353900.1799
Y: -5584618.6433
Z: 1981221.1234
CHX: GPX
CHY: GPY
CHZ: GPZ
LEAP_SECONDS: 18

Gsof2Ring.desc descriptor file

The descriptor files follows the normal Earthworm descriptor files structure and must include:

modName  gsof2ew
modId    MOD_GSOF2EW
instId  ${EW_INST_ID}

Where:
modName: a unique name for this module (May include station name)
modId: a unique Module ID as stated in earthworm.d (must be the same in .d)
instId: usually left as ${EW_INST_ID} (and must be the same one stated in .d)

Contact us

If you have any comment or question contact us at:

Boritech Solutions

Acknowledgement:

The development and maintenance of Gsof2Ring is funded entirely by software and research contracts with Boritech Solutions.