https://github.com/nasa-ammos/labelocity
Flexible, customizable, multimission automated system for PDS4 label production
https://github.com/nasa-ammos/labelocity
Last synced: about 1 year ago
JSON representation
Flexible, customizable, multimission automated system for PDS4 label production
- Host: GitHub
- URL: https://github.com/nasa-ammos/labelocity
- Owner: NASA-AMMOS
- License: apache-2.0
- Created: 2023-04-14T20:43:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T01:20:53.000Z (over 2 years ago)
- Last Synced: 2025-03-20T19:28:25.272Z (about 1 year ago)
- Language: Shell
- Size: 19.5 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Labelocity
**Labelocity:** Multimission PDS4 Labels is a flexible, customizable, multimission automated system for PDS4 label production at NASA Jet Propulsion Laboratory (JPL).
The **Labelocity** toolset is a [standalone application](https://github.com/NASA-AMMOS/labelocity) and is also included with the [VICAR general purpose image processing system](https://github.com/NASA-AMMOS/VICAR).
[Labelocity is being presented at the Universities Space Research Association (USRA) 6th Planetary Data Workshop in Flagstaff, AZ on Monday, June 26, 2023](https://www.hou.usra.edu/meetings/planetdata2023/technical_program/?session_no=302) and is also discussed in the [6th Planetary Data Workshop (2023), abstract #7071](https://www.hou.usra.edu/meetings/planetdata2023/pdf/7071.pdf).
# What's New in Release 1
This initial release provides the following features:
- Flexible, customizable, automated multi-mission system for label production
- Reusable Velocity macros
- Driver scripts with a wrapper around the [PDS tool mi-label](https://github.com/NASA-PDS/mi-label/)
- Create labels from a variety of data sources, including ODL (PDS3) products, VICAR images and JSON metadata
**Labelocity** has been used to create most of the image, browse, mesh, calibration and documentation labels for several key missions, including the InSight and Mars 2020 missions.
# Obtaining Labelocity
**Labelocity** can be obtained in two ways: pre-built binaries via tarball/ZIP download (which includes executable scripts), or source code via github.com.
### Requirements
To fully utilize **Labelicity** workstations must have the following software components pre-installed and available:
- The `tcsh` ([Tenex C Shell](https://www.tcsh.org/)), a `csh`-compatible shell installed and available to run most scripts. (This is usually pre-installed in Unix-based systems, including Macs, that provide shell prompts.)
- (Planned future versions may provide feature-identical [BASH shell](https://www.gnu.org/software/bash/)-based scripts.)
- A `python3` installation, preferebly [Python 3.9.13](https://www.python.org/downloads/release/python-3913/) or newer, as provided by [Python.org](https://www.python.org/downloads/), to run certain scripts.
- A [Java 8-compatible JRE or JDK](https://adoptium.net/temurin/releases/?version=8), such as [OpenJDK](https://adoptopenjdk.net/releases.html), to launch `java` to execute compiled bytecode at the heart of Labelocity.
### Source Code
- GitHub: https://github.com/NASA-AMMOS/labelocity
- Main Labelocity toolset source: [Click to download](https://github.com/NASA-AMMOS/labelocity/tarball/master) or [visit Releases for additional downloadable formats](https://github.com/NASA-AMMOS/labelocity/releases)
### Software Components
The Labelocity toolset consists of three complementary components separated by directory:
- `bin`: The `bin` directory consists largely of executable scripts in `tcsh` or `python 3` that wrap operations with command calls accepting various topical arguments.
- `jars`: Core image labeling functionality is pre-compiled into Java `JAR`s that are invoked by scripts in `bin`.
- `templates`: Velocity macro templates invoked by the scripts and used by the JARs to produce requested labeling outputs.
### Running the Toolset
_Executing **Labelocity** may begin by `cd`-ing to its directory and launching `./init.sh` which sets up the environment and launches the correct interpreter._.
**Note that experienced `tcsh` users** can proceed by setting an environment variable and sourcing the **Labelocity** variable set:
```
setenv LABELOCITY_ROOT /path/to/unpacked/labelocity/distributable
source $LABELOCITY_ROOT/initenv
```
Then, scripts may be run from any directory on the system.
# Getting Started and Documentation
Running **Labelocity** is as quick as cloning this repository (or unpacking one of the above archives) and launching a script:
- Executing `./init.sh` launches a `tcsh` shell with properly sourced environment variables
- Experienced `tcsh` users may choose to set a `LABELOCITY_ROOT` environment variable and source settings manually so that scripts may be invoked from any directory tree location
Usage of the **Labelocity** toolset is described more fully in the Labelocity User Guide:
- [Labelocity User Guide](docs/LabelocityUserGuide_v1.0.pdf)
For more information on VICAR Open Source, the progenitor of **Labelocity**, documentation is available by [clicking here](https://github.com/NASA-AMMOS/VICAR#getting-started-and-documentation).
# VICAR Discussion Forums
We've set up online groups to help users collaborate and interact on VICAR-related subjects, where you can find notifications of new releases, view bug reports and participate in general discussions:
* The [VICAR Open Source Google group](https://groups.google.com/forum/#!forum/vicar-open-source/) can be joined [here](https://groups.google.com/forum/#!forum/vicar-open-source/join).
* A **#vicar** channel is available in the [OpenPlanetary Slack workspace](http://openplanetary.slack.com/) ([join here](https://www.openplanetary.org/join))
Since **Labelocity** originates with VICAR, these forums are an ideal place to follow up for this application.
Questions: [vicar_help@jpl.nasa.gov](mailto:vicar_help@jpl.nasa.gov)
# Modifying Labelocity
One of the prime purposes of Open Source is to solicit contributions from the community, and we welcome such contributions. However, at the current time, this git repo is read-only. At some point in the future, we hope to make this easier, but for now, send any changes to [vicar_help@jpl.nasa.gov](mailto:vicar_help@jpl.nasa.gov) for further discussion. As this software is part of the [VICAR Suite](https://github.com/NASA-AMMOS/VICAR) used in mission surface operations, changes are vetted carefully. Getting more contributions from the community will help make the case for improved governance in the public sphere.