Table of Contents

GipsyX

Important License Information

The license for using this software is restrictive. As part of the terms of the license it is only available to select HPC projects on Comet. If you need to use this software and you are not a member of a project which already has access, then please contact us first.

GipsyX is developed by the Jet Propulsion Laboratory (JPL), and maintained by the Near Earth Tracking Applications and Systems groups. It replaces the GIPSY-OASIS (GNSS-Inferred Positioning System and Orbit Analysis Simulation Software) software.

Features:

Applications:

For further information: https://gipsyx.jpl.nasa.gov/


Running GipsyX on Comet

GipsyX has been installed on Comet as an application container. This allows the software to be fully restricted to the HPC project group(s) who are allowed access as part of the terms of the license. It also allows the staff in those groups to update the container to new software versions as-and-when required without any superuser intervention.

To be written

Sample GipsyX Slurm Job

To be written


Running GipsyX graphical tools on Comet

To be written


Building GipsyX on Comet

Important!

This section is only relevant to RSE HPC support staff or users who want to understand how GipsyX has been installed. If you only want to use the software, stop reading now.

This section is still in development!!!

You will need:

The output will be a single file named gipsyx.sif, containing the GipsyX software and all runtime dependencies. This should be copied to a location only accessible to members of the allowed HPC project group. We therefore suggest the use of your /nobackup/proj/PROJECT_NAME folder.

Container Definition:

This file should be named gipsyx.def.

Bootstrap: docker
From: ubuntu:jammy

####################################################################
# GipsyX Container
# ==================
# This is a runtime environment for GipsyX
# Please see: 
#	https://hpc.researchcomputing.ncl.ac.uk/dokuwiki/dokuwiki/doku.php?id=advanced:software:gipsyx
#
####################################################################
%post
    # Prevent interactive prompts
    export DEBIAN_FRONTEND=noninteractive

####################################################################
# Basic system packages
####################################################################

	# Update & install only necessary packages
	apt-get update
	apt-get install -y wget unzip
	
	# Clean up APT cache to save space
	apt-get clean 

	# Remove all src packages
	cd /
	rm -rf /src

####################################################################
# Additional environment variables
####################################################################
%environment

%runscript

Runtime Helper:

This file should be named gipsyx.sh, and should be set executable with chmod 750 gipsyx.sh.

#!/bin/bash

module load apptainer

IMAGE_NAME=/nobackup/proj/YOUR_PROJECT_DIRECTORY/gipsyx.sif

container.run() {
	# Run a command inside the container...
	# automatically bind the /scratch and /nobackup dirs
	# pass through any additional parameters given on the command line
	apptainer exec --bind /nobackup/proj/YOUR_PROJECT_DIRECTORY/gipsyx_config:/opt/gipsyx/etc --bind /scratch:/scratch --bind /nobackup:/nobackup ${IMAGE_NAME} $@
}

Steps to building a new container

Put the files gipsyx.def and gipsyx.tar.gz in the same directory, save the following script as gipsyx.build.sh in the same directory and then run it:

#!/bin/bash
module load apptainer

# Build the container image
apptainer build gipsyx.sif gipsyx.def

# Set the container to be readable by self and group only
chmod 440 gipsyx.sif


Back to software