Repository files navigation

Java library providing APIs for parsing and exporting informationon 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 websitehttps://NASA-PDS.github.io/pds4-jparser/ for information on installation, use, operation, and alsodevelopment of this software.

Looking for a Python library? See thePlanetary Data Reader (pdr)

Current software requires:

• Maven 3

The documentation including release notes, installation and operation of thesoftware should be online athttps://NASA-PDS.github.io/pds4-jparser/. If it is notaccessible, you can execute the "mvn site:run" command and view thedocumentation locally athttp://localhost:8080.

The software can be compiled and built with the "mvn compile" command but in orderto create the JAR file, you must execute the "mvn compile jar:jar" command.

In order to create a complete distribution package, execute thefollowing commands:

mvn sitemvn package

When new PDS4 Information Model is available, run the following script to download the latest IM andpush to git.

$ build/pre-build.shpre-build.sh <dev_or_ops> <IM version>     dev_or_ops - still in dev or released     IM Version - e.g. 1D00# For dev release of IMbuild/pre-build.sh dev 1E00For operation release of IMbuild/pre-build.sh ops 1E00

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.

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 pom.xml for the release version or use the Maven Versions Plugin usingsemantic versioning. 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.0mvn versions:set -DnewVersion=$VERSION

Update Changelog using 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 using following template commit message:

[RELEASE] PDS4 Java Parser Library v$VERSION

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:

<profiles>  <profile>    <activation>      <activeByDefault>true</activeByDefault>    </activation>    <properties>      <gpg.executable>gpg</gpg.executable>      <gpg.keyname>KEY_NAME</gpg.keyname>      <gpg.passphrase>KEY_PASSPHRASE</gpg.passphrase>    </properties>  </profile></profiles>

git tag v$VERSIONgit push --tags

From cloned repo:

git checkout gh-pages# Create specific version sitemv target/site $VERSIONrm -fr target# Sync latest version to ops rsync -av $VERSION/* .git add .git commit -m "Deploy v$VERSION docs"git push origin gh-pages

Updatepom.xml with the next SNAPSHOT version either manually or using Github Versions Plugin, e.g.:

git checkout mainVERSION=1.16.0-SNAPSHOTmvn versions:set -DnewVersion=$VERSIONgit add pom.xmlgit commit -m "Update version for $VERSION development"git push -u origin main

Currently the process to create more formal release notes and attach Assets is done manually through theGithub UI but should eventually be automated via script.

1. Checkout the main branch.

2. Deploy software to Sonatype Maven repo:

mvn clean site deploy

https://search.maven.org/search?q=g:gov.nasa.pds%20AND%20a:pds4-jparser&core=gav

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:

<profiles>  <profile>     <id>allow-snapshots</id>     <activation><activeByDefault>true</activeByDefault></activation>     <repositories>       <repository>         <id>snapshots-repo</id>         <url>https://oss.sonatype.org/content/repositories/snapshots</url>         <releases><enabled>false</enabled></releases>         <snapshots><enabled>true</enabled></snapshots>       </repository>     </repositories>   </profile></profiles>