From 7e5de1b3acc8dbe1feed2c451a6b79ca42bebf0a Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Mon, 17 Jun 2024 08:26:14 -0500 Subject: [PATCH] Update comments (#287) * Create a publish workflow * Add Usersguide to workflow * Cleanup workflows --- .github/workflows/ant-app.yml | 2 +- .github/workflows/ant.yml | 2 +- .github/workflows/daily-build.yml | 9 ++-- .github/workflows/publish-release.yml | 10 ++-- .github/workflows/release-files.yml | 2 +- .github/workflows/release.yml | 1 + .github/workflows/remove-files.yml | 2 +- .github/workflows/tarball.yml | 2 +- docs/UsersGuide/RELEASE.txt | 75 ++++++++++++++++++--------- 9 files changed, 64 insertions(+), 41 deletions(-) diff --git a/.github/workflows/ant-app.yml b/.github/workflows/ant-app.yml index 99344a00..104086df 100644 --- a/.github/workflows/ant-app.yml +++ b/.github/workflows/ant-app.yml @@ -1,6 +1,6 @@ name: hdfview 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 index 0009fdac..6f0cdd60 100644 --- a/.github/workflows/ant.yml +++ b/.github/workflows/ant.yml @@ -1,6 +1,6 @@ name: hdfview 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 index bf0e4f3b..3c59b8c4 100644 --- a/.github/workflows/daily-build.yml +++ b/.github/workflows/daily-build.yml @@ -1,5 +1,6 @@ name: hdfview daily build +# Triggered on pull request or schedule or on demand on: workflow_dispatch: inputs: @@ -16,8 +17,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 @@ -35,13 +34,13 @@ jobs: with: version: 'tags/HDFView-99.99.99' file: 'last-file.txt' - + - 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 index 7e7cec61..f14305a8 100644 --- a/.github/workflows/publish-release.yml +++ b/.github/workflows/publish-release.yml @@ -1,6 +1,6 @@ name: hdfview publishrelease -# Controls when the action will run. Triggers the workflow on a schedule +# Triggers the workflow on demand on: workflow_dispatch: inputs: @@ -14,9 +14,7 @@ on: required: true permissions: contents: read - - # A workflow run is made up of one or more jobs that can run sequentially or - # in parallel. + jobs: publish-tag: runs-on: ubuntu-latest @@ -55,12 +53,12 @@ jobs: - name: Sync release to S3 bucket run: | - aws s3 sync ./HDFVIEW s3://${{ secrets.AWS_S3_BUCKET }}/ftp2/HDFVIEW/${{ inputs.target_dir }}/downloads --delete + 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 }}/ftp2/HDFVIEW/${{ inputs.target_dir }}/documentation --delete + 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 index 274d6ecb..5ff551d2 100644 --- a/.github/workflows/release-files.yml +++ b/.github/workflows/release-files.yml @@ -1,6 +1,6 @@ name: hdfview 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: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 85b6bfff..cf0d9e33 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,5 +1,6 @@ name: hdfview 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 index b68131f2..7ddf2713 100644 --- 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 index cfb6cb02..1c2ec5f5 100644 --- a/.github/workflows/tarball.yml +++ b/.github/workflows/tarball.yml @@ -1,6 +1,6 @@ name: hdfview 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: diff --git a/docs/UsersGuide/RELEASE.txt b/docs/UsersGuide/RELEASE.txt index 070602d1..7b01e9cf 100644 --- 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.15.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 ==============================================================================