Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nasa-pds/pds4-jparser
Java Library providing APIs for parsing and exporting information on PDS4 products, including table and image objects to various formats including CSV, PNG, VICAR, FITs, etc.
https://github.com/nasa-pds/pds4-jparser
nasa nasa-pds pds4
Last synced: about 1 month ago
JSON representation
Java Library providing APIs for parsing and exporting information on PDS4 products, including table and image objects to various formats including CSV, PNG, VICAR, FITs, etc.
- Host: GitHub
- URL: https://github.com/nasa-pds/pds4-jparser
- Owner: NASA-PDS
- License: other
- Created: 2019-06-26T00:16:21.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T19:02:32.000Z (about 2 months ago)
- Last Synced: 2024-11-07T20:17:29.237Z (about 2 months ago)
- Topics: nasa, nasa-pds, pds4
- Language: HTML
- Homepage: https://nasa-pds.github.io/pds4-jparser/
- Size: 36.3 MB
- Stars: 3
- Watchers: 8
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# PDS4 JParser
[](https://doi.org/10.5281/zenodo.5725957) [](https://github.com/NASA-PDS/pds4-jparser/actions/workflows/unstable-cicd.yaml) [](https://github.com/NASA-PDS/pds4-jparser/actions/workflows/stable-cicd.yaml)
Java library providing APIs for parsing and exporting information
on PDS4 table and image objects to various formats including CSV, PNG, Vicar,
Fits, etc. The software is packaged in a JAR file.
Please visit the website https://NASA-PDS.github.io/pds4-jparser/ for information on installation, use, operation, and also *development* of this software.
**Looking for a Python library? See the [Planetary Data Reader (pdr)](https://github.com/MillionConcepts/pdr)**
# System Requirements
Current software requires:
* Maven 3
# Documentation
The documentation including release notes, installation and operation of the
software should be online at https://NASA-PDS.github.io/pds4-jparser/. If it is not
accessible, you can execute the "mvn site:run" command and view the
documentation locally at http://localhost:8080.
# Build
The software can be compiled and built with the "mvn compile" command but in order
to create the JAR file, you must execute the "mvn compile jar:jar" command.
In order to create a complete distribution package, execute the
following commands:
```
mvn site
mvn package
```
# Operational Release
## Run pre-build software
When new PDS4 Information Model is available, run the following script to download the latest IM and
push to git.
```
$ build/pre-build.sh
pre-build.sh
dev_or_ops - still in dev or released
IM Version - e.g. 1D00
# For dev release of IM
build/pre-build.sh dev 1E00
For operation release of IM
build/pre-build.sh ops 1E00
```
## Release with ConMan
For internal JPL use, the ConMan software package can be used for releasing software, otherwise the following sections outline how to complete these steps manually.
## Manual Release
Note that GitHub Actions are enabled for the repository of this software so that automated SNAPSHOT and stable releases are available. Manual release instructions follow below.
### Update Version Numbers
Update pom.xml for the release version or use the Maven Versions Plugin using [semantic versioning](https://semver.org/). For IM release candidates and operational releases, PDS4 JParser will be built and deployed as an operational release and versioned and re-build if needed.
```
VERSION=1.1.0
mvn versions:set -DnewVersion=$VERSION
```
### Update Changelog
Update Changelog using [ Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator). Note: Make sure you set `$CHANGELOG_GITHUB_TOKEN` in your `.bash_profile` or use the `--token` flag.
```
github_changelog_generator --future-release v$VERSION
```
### Commit Changes
Commit changes using following template commit message:
```
[RELEASE] PDS4 Java Parser Library v$VERSION
```
### Build and Deploy Software to [Sonatype Maven Repo](https://repo.maven.apache.org/maven2/gov/nasa/pds/).
```
mvn clean site deploy -P release
```
Note: If you have issues with GPG, be sure to make sure you've created your GPG key, sent to server, and have the following in your `~/.m2/settings.xml`:
```
true
gpg
KEY_NAME
KEY_PASSPHRASE
```
### Push Tagged Release
```
git tag v$VERSION
git push --tags
```
### Deploy Site to Github Pages
From cloned repo:
```
git checkout gh-pages
# Create specific version site
mv target/site $VERSION
rm -fr target
# Sync latest version to ops
rsync -av $VERSION/* .
git add .
git commit -m "Deploy v$VERSION docs"
git push origin gh-pages
```
### Update Versions For Development
Update `pom.xml` with the next SNAPSHOT version either manually or using Github Versions Plugin, e.g.:
```
git checkout main
VERSION=1.16.0-SNAPSHOT
mvn versions:set -DnewVersion=$VERSION
git add pom.xml
git commit -m "Update version for $VERSION development"
git push -u origin main
```
### Complete Release in Github
Currently the process to create more formal release notes and attach Assets is done manually through the [Github UI](https://github.com/NASA-PDS/pds4-jparser/releases/new) but should eventually be automated via script.
## Snapshot Release
1. Checkout the main branch.
2. Deploy software to Sonatype Maven repo:
```
mvn clean site deploy
```
# JAR Dependency Reference
## Official Releases
https://search.maven.org/search?q=g:gov.nasa.pds%20AND%20a:pds4-jparser&core=gav
## Snapshots
https://oss.sonatype.org/content/repositories/snapshots/gov/nasa/pds/pds4-jparser
If you want to access snapshots, add the following to your `~/.m2/settings.xml`:
```
allow-snapshots
true
snapshots-repo
https://oss.sonatype.org/content/repositories/snapshots
false
true
```