Merge master Usersguide and package jars changes (#297)

HDFGroup · Jun 24, 2024 · eb54c8f · eb54c8f
1 parent c258808
commit eb54c8f
Show file tree

Hide file tree

Showing 141 changed files with 239 additions and 914 deletions.
diff --git a/.github/workflows/ant-app.yml b/.github/workflows/ant-app.yml
@@ -1,6 +1,6 @@
 name: hdfview 1_14 app ci runs
 
-# Controls when the action will run. Triggers the workflow on a schedule
+# Triggers the workflow on a call from another workflow
 on:
   workflow_call:
     inputs:

diff --git a/.github/workflows/ant.yml b/.github/workflows/ant.yml
@@ -1,6 +1,6 @@
 name: hdfview 1_14 ci runs
 
-# Controls when the action will run. Triggers the workflow on a schedule
+# Triggers the workflow on a call from another workflow
 on:
   workflow_call:
     inputs:

diff --git a/.github/workflows/daily-build.yml b/.github/workflows/daily-build.yml
@@ -1,5 +1,6 @@
 name: hdfview 1_14 daily build
 
+# Triggered on pull request or on demand
 on:
   workflow_dispatch:
     inputs:
@@ -14,8 +15,6 @@ on:
 permissions:
   contents: read
 
-# A workflow run is made up of one or more jobs that can run sequentially or
-# in parallel.
 jobs:
   get-base-names:
     runs-on: ubuntu-latest
@@ -33,13 +32,14 @@ jobs:
       with:
         version: 'tags/HDFView-3.3.99'
         file: 'last-file.txt'
-
+      continue-on-error: true
+
     - name: Read base-name file
       id: gethdfviewbase
       run: echo "HDFVIEW_NAME_BASE=$(cat last-file.txt)" >> $GITHUB_OUTPUT
-    
+
     - run: echo "hdfview base name is ${{ steps.gethdfviewbase.outputs.HDFVIEW_NAME_BASE }}."
-    
+
     - name: Get hdf4 release base name
       uses: dsaltares/fetch-gh-release-asset@master
       with:

diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -0,0 +1,64 @@
+name: hdfview 1.14 publishrelease
+
+# Triggers the workflow on demand
+on:
+  workflow_dispatch:
+    inputs:
+      use_tag:
+        description: 'HDFView Release version tag'
+        type: string
+        required: true
+      target_dir:
+        description: 'HDFView target bucket directory'
+        type: string
+        required: true
+    permissions:
+      contents: read
+
+jobs:
+  publish-tag:
+    runs-on: ubuntu-latest
+    steps:
+        # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+        - name: Get Sources
+          uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+          with:
+            fetch-depth: 0
+            ref: '${{ github.head_ref || github.ref_name }}'
+
+        - name: Get hdfview release
+          uses: dsaltares/fetch-gh-release-asset@master
+          with:
+            repo: 'HDFGroup/hdfview'
+            version: 'tags/${{ inputs.use_tag }}'
+            regex: true
+            target: 'HDFVIEW/'
+            file: '${{ inputs.use_hdf }}-*.*'
+
+        - name: Get hdfview release UG
+          uses: dsaltares/fetch-gh-release-asset@master
+          with:
+            repo: 'HDFGroup/hdfview'
+            version: 'tags/${{ inputs.use_tag }}'
+            regex: true
+            target: 'HDFVIEW/'
+            file: 'UsersGuide.*'
+
+        - name: Setup AWS CLI
+          uses: aws-actions/configure-aws-credentials@v1
+          with:
+                 aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+                 aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+                 aws-region: ${{ secrets.AWS_REGION }}
+
+        - name: Sync release to S3 bucket
+          run: |
+                aws s3 sync ./HDFVIEW s3://${{ secrets.AWS_S3_BUCKET }}/${{ vars.TARGET_PATH }}/${{ inputs.target_dir }}/downloads --delete
+
+        - name: Uncompress source (Linux)
+          run: tar -zxvf ${{ github.workspace }}/UsersGuide.tar.gz
+
+        - name: Sync userguide to S3 bucket
+          run: |
+                aws s3 sync ./UsersGuide s3://${{ secrets.AWS_S3_BUCKET }}/${{ vars.TARGET_PATH }}/${{ inputs.target_dir }}/documentation --delete
+
diff --git a/.github/workflows/release-files.yml b/.github/workflows/release-files.yml
@@ -1,6 +1,6 @@
 name: hdfview 1_14 release-files
 
-# Controls when the action will run. Triggers the workflow on a schedule
+# Triggers the workflow on a call from another workflow
 on:
   workflow_call:
     inputs:
@@ -122,6 +122,21 @@ jobs:
               name: tgz-ubuntu-2204-app-binary
               path: ${{ github.workspace }}
 
+      # Get files created by tarball script
+      - name: Get UsersGuide (Linux)
+        uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
+        with:
+              name: docs-usersguide
+              path: ${{ github.workspace }}/UsersGuide
+
+      - name: Create snapshot source file (tgz and zip)
+        id: create-release-files
+        if: ${{ (inputs.use_environ == 'snapshots') }}
+        run: |
+              zip -r UsersGuide.zip ./UsersGuide
+              tar -zcvf UsersGuide.tar.gz ./UsersGuide
+        shell: bash
+
       - name: List files for the space
         run: |
             ls -l ${{ github.workspace }}
@@ -137,6 +152,8 @@ jobs:
           sha256sum ${{ steps.get-file-base.outputs.FILE_BASE }}App-Linux-x86_64.tar.gz >>${{ steps.get-file-base.outputs.FILE_BASE }}.sha256sums.txt
           sha256sum ${{ steps.get-file-base.outputs.FILE_BASE }}App-win64.zip >>${{ steps.get-file-base.outputs.FILE_BASE }}.sha256sums.txt
           sha256sum ${{ steps.get-file-base.outputs.FILE_BASE }}App-Darwin.tar.gz >>${{ steps.get-file-base.outputs.FILE_BASE }}.sha256sums.txt
+          sha256sum UsersGuide.tar.gz >> ${{ steps.get-file-base.outputs.FILE_BASE }}.sha256sums.txt
+          sha256sum UsersGuide.zip >> ${{ steps.get-file-base.outputs.FILE_BASE }}.sha256sums.txt
 
       - name: Store snapshot name
         run: |
@@ -162,6 +179,8 @@ jobs:
           body_path: description.txt
           files: |
               last-file.txt
+              UsersGuide.tar.gz
+              UsersGuide.zip
               ${{ steps.get-file-base.outputs.FILE_BASE }}.tar.gz
               ${{ steps.get-file-base.outputs.FILE_BASE }}.zip
               ${{ steps.get-file-base.outputs.FILE_BASE }}-Linux-x86_64.tar.gz
@@ -182,6 +201,8 @@ jobs:
           prerelease: false
           body_path: description.txt
           files: |
+              UsersGuide.tar.gz
+              UsersGuide.zip
               ${{ steps.get-file-base.outputs.FILE_BASE }}.tar.gz
               ${{ steps.get-file-base.outputs.FILE_BASE }}.zip
               ${{ steps.get-file-base.outputs.FILE_BASE }}-Linux-x86_64.tar.gz

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,5 +1,6 @@
 name: hdfview 1_14 release build
 
+# Triggers the workflow on demand
 on:
   workflow_dispatch:
     inputs:

diff --git a/.github/workflows/remove-files.yml b/.github/workflows/remove-files.yml
@@ -1,6 +1,6 @@
 name: hdfview remove-files
 
-# Controls when the action will run. Triggers the workflow on a schedule
+# Triggers the workflow on a call from another workflow
 on:
   workflow_call:
     inputs:

diff --git a/.github/workflows/tarball.yml b/.github/workflows/tarball.yml
@@ -1,6 +1,6 @@
 name: hdfview 1_14 tarball
 
-# Controls when the action will run. Triggers the workflow on a schedule
+# Triggers the workflow on a call from another workflow
 on:
   workflow_call:
     inputs:
@@ -138,6 +138,14 @@ jobs:
               path: ./hdfsrc/docs/RELEASE.txt
               if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
 
+      # Save User Guide
+      - name: Save User Guide (Linux)
+        uses: actions/upload-artifact@v4
+        with:
+              name: docs-usersguide
+              path: ./hdfsrc/docs/UsersGuide
+              if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
+
       - name: Create release source file (tgz and zip)
         id: create-snapshot-files
         if: ${{ (inputs.use_environ == 'release') }}

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-HDFView version 3.3.2 currently under development
+HDFView version 3.3.3 currently under development
 
 ![HDF5 Logo](src/HDFView.png)
 
@@ -13,7 +13,7 @@ HELP AND SUPPORT
 ----------------
 Information regarding Help Desk and Support services is available at
 
-   https://portal.hdfgroup.org/display/support/The+HDF+Help+Desk
+   https://help.hdfgroup.org/
 
 
 FORUM and NEWS
@@ -55,7 +55,7 @@ PREVIOUS RELEASES AND SOURCE CODE
 --------------------------------------------
 Source packages for current and previous releases are located at:
 
-   https://portal.hdfgroup.org/display/support/Download+HDFView
+   https://support.hdfgroup.org/downloads/HDFVIEW/index.html
 
 Development code is available at our Github location:
 

diff --git a/build.xml b/build.xml
@@ -250,7 +250,7 @@
         <fileset dir="${lib.dir}/extra" includes="slf4j-nop${version.slf4j}.jar" excludes="*sources.jar" />
     </path>
     <path id="unit-classpath">
-        <fileset dir="${lib.dir}" includes="extra/junit-4.13.2.jar extra/hamcrest-core-1.3.jar" excludes="*sources.jar" />
+        <fileset dir="${lib.dir}" includes="org.junit.jar org.hamcrest.jar" excludes="*sources.jar" />
     </path>
     <path id="swtbot-classpath">
         <fileset dir="${lib.dir}/ext/swt/swtbot" includes="*swtbot*.jar *log4j*.jar" excludes="*sources.jar" />

diff --git a/docs/UsersGuide/RELEASE.txt b/docs/UsersGuide/RELEASE.txt
@@ -1,43 +1,68 @@
 The current HDFView products can be downloaded at:
-        https://www.hdfgroup.org/downloads/hdfview/
+        https://github.com/HDFGroup/hdfview/releases
 
 
 HDF Libraries
 =============================================================================
-This release was built and tested with HDF 4.2.15 and HDF5 1.10.7.
-
-Windows ONLY: HDFView built with VS 2015 will require that
-the Visual C++ Redistributable Packages be installed on your machine.
-If you cannot access HDF5 files then you do not have these packages.
-You can obtain them from:
-         https://www.microsoft.com/en-us/download/details.aspx?id=48145
+This release was built and tested with HDF 4.3.x and HDF5 1.14.x.
 
 
 JDK
 =============================================================================
-This release was built and tested with OpenJDK 15. It uses modules and the
-newest jpackage for distribution.
+This release was built and tested with OpenJDK 21. It uses modules, the
+newest jpackage for distribution and adds support for float16 datatypes.
+
 
 Major Enhancements
 ==============================================================================
-    *
+    * GH #117 Add User Option for editing the plugin path and include plugins.
+    * GH #138 Add Support for operating with float16 datatypes.
+
+    ***** Previous fixes *****
+    * GH #121 Updated all icons with transparency.
 
 Major Bug Fixes
 ==============================================================================
-    * Added support to read and display non-standard floating point numbers.
-    * Added optional startDir to command line options.
-    * Corrected user.home vs user.dir confusion.
-    * Split Current Working Directory options into three selections:
-      a. Current Work Directory or user.dir system property
-      b. User Home Directory or user.home system property
-      c. User selected directory
+    *
+
+    ***** Previous fixes *****
+    * GH #119 (crashes opening HDF4 file) has been fixed. The problem was
+      that the HDF4 xdr.dll file was not copied from the hdf4 install location.
+
+    * HDFVIEW-284 (crashes on NETCDF-4 grids) has been fixed. The problem was
+      that references in variable-length containers were handled like strings.
+      Upon investigation, the problem found was that references in any container
+      were handled like strings.
+        The table display code for vlen references  also changed to account for
+      the changes which fixed the hdf5 Java API. The fix required that
+      variable-length types in the Java wrappers in the
+      hdf5 library for read and write also be fixed.
+
+      HDFView-221 Add support for true Variable-length types in Java
+      Sub-issue HDFView-222 fixed the read/write support for variable-length
+      in the Java wrappers. This fix involved handling the data object as
+      a list of lists and using the datatype of the list.
+      Sub-issue HDFView-222 fixed the object library to handle the List of Lists
+      concept.
+      Sub-issue HDFView-223 updated the DataProviders, DataDisplayConverters
+      and DataValidators to work with variable-length List of Lists.
+
 
 Minor Bug Fixes
 ==============================================================================
-    * Corrected the create new attribute dialog from trying to write
-      the attribute twice.
-    * Added an initilize lib version bounds function. Now the change
-      lib version dialog correctly preloads the combo box values.
+    * GH #159 (Help menu dialogs have gigantic images) Implemented by changing the size from 1024 to 256.
+    * GH #171 (HDFView fails to find input files on command line when using relative paths)
+
+    ***** Previous fixes *****
+    * Corrected how the program updates changes to the fonts made in the User Preferences
+      dialog. There are still issues with having to trigger a visual refresh.
+
+    * GH #73 (Check aarch64 in machine.arch property) fixed by adding a section to
+      for aarch64.
+
+    * GH #147 (HDFView 3.3.0 shows incorrect references in compound types in datasets)
+      fixed by adding a start index into the object reference array of data read from a
+      compound type.
 
 
 Limitations / Known Problems
@@ -51,9 +76,6 @@ Limitations / Known Problems
     * HDFView also cannot nicely handle large numbers of objects, because of
       a design issue that requires HDFView to visit all the objects in a file.
 
-    * Writing of variable-length types other than variable-length strings is
-      currently unsupported.
-
     * Object/region references can't be opened by a double-click or by
       right-clicking and choosing "Show As Table/Image" when inside a compound
       datatype.
@@ -72,6 +94,9 @@ Limitations / Known Problems
 
     * Logging and optional HDF4 requires rebuilds from source.
 
+    * Automatically opening HDFView and displaying a file selected still does
+      not display the file on a mac.
+
 
 Other Notes
 ==============================================================================

diff --git a/docs/UsersGuide/index.html b/docs/UsersGuide/index.html
@@ -1,10 +1,6 @@
-<?php
-$page_title = "HDFView User's Guide";
-include ("../../../../links.php");
-include ("../../../../includes/header.html");
-?>
-<link href="edit.css" rel="stylesheet" type="text/css" />
+<html><head><link href="edit.css" rel="stylesheet" type="text/css">
 
+</head><body>
 <p>
 <a href="index.html">[Index]</a>
 <a href="ug01introduction.html">[1]</a>
@@ -35,7 +31,7 @@
 A brief discussion of the HDF object model
 (Details of the HDF object model are available from
 
-<a href="javadocs/hdfview_java_doc/hdf/object/package-summary.html">HDF Object Package</a>.)</li>
+<a href="../javadocs/org.hdfgroup.object/hdf/object/package-summary.html">HDF Object Package</a>.)</li>
 
 </ul>
 
@@ -189,7 +185,6 @@ <h2>Table of Contents</h2>
 <!-- END OF FOOTER INFO -->
 
 <hr />
-<?php
-include ("../../../../includes/footer.html");
-?>
+</body>
+</html>