JOSS release

[streeve]

1. Paper: I would suggest removing "the source code for AdditiveFOAM has been archived to Zenodo" since it's in the front page metadata already
2. We should add a CHANGELOG.md in the repo (which we can copy for the release notes)
3. Is there a way to report the version number? If so we'll need to update

---

Pre-release checklist:

• Merge added version and build info to additivefoam for tracking #50
• Create PR for joss-2024 branch to merge to main
• Merge Add joss paper to main for 1.1.0 release #52
• Revert "Add joss paper to main for 1.1.0 release (#52)" #55
• Final check with JOSS editor to make sure paper metadata is good before release
• Final PR tasks for release
  • update static version number to 1.1.0 and update changelog
  • [] update readme.md to point to dynamic DOI
  • Add ORCID ids to author metadata

Post-release checklist:

• [ ] Delete PDF CI
• Create developupdate_version_2-dev branch
  • Update static version number to 1.2.0-dev

---

Release Notes

New features

• Additional tutorials and examples of ExaCA solidification data output
• New utility to create scan paths

Bug fixes and improvements

• Fixes a typo in the normalization factor for the modifiedSuperGaussian heat source model
• Improvements to heat source integration and solution stability
• Version number is output at the beginning of the AdditiveFOAM log file during runtime. If the code was built from a git repository, Git information will be included
• paper.md describes the functionality of the software, corresponding to JOSS article
• Improves CI
• Improves documentation

[gknapp1]

I'm going to edit @streeve's comment to include a draft of the release notes and a checklist of pre-release tasks.

[KDSisco]

Hello just a heads up that the manual install does not appear to be working in the new version.
The error

  additiveFoam.C:35:10: fatal error: Make/additiveFoamVersion.H: No such file or directory
     35 | #include "Make/additiveFoamVersion.H"
        |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~

Comes up during the second compiling step

cd $WM_PROJECT_USER_DIR/AdditiveFOAM/applications/solvers/additiveFoam
wmake

If you checkout an earlier version see (previous to the JOSS Update)
git checkout 6e71770

The compilation works and has been tested with the AMB test.

note: I have never gotten the SPACK install to work, however I assume it has always been an issue on my end because it cannot find a FORTRAN compiler, but recently learned that multiple users have been having trouble installing via spack. (I know this isn't helpful, but just a heads up.)

[colemanjs]

Hello just a heads up that the manual install does not appear to be working in the new version. The error

  additiveFoam.C:35:10: fatal error: Make/additiveFoamVersion.H: No such file or directory
     35 | #include "Make/additiveFoamVersion.H"
        |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~

Comes up during the second compiling step

cd $WM_PROJECT_USER_DIR/AdditiveFOAM/applications/solvers/additiveFoam
wmake

If you checkout an earlier version see (previous to the JOSS Update) git checkout 6e71770

The compilation works and has been tested with the AMB test.

note: I have never gotten the SPACK install to work, however I assume it has always been an issue on my end because it cannot find a FORTRAN compiler, but recently learned that multiple users have been having trouble installing via spack. (I know this isn't helpful, but just a heads up.)

Good catch - thanks @KDSisco . We are working under the assumption that AdditiveFOAM is currently being built with the Allwmake script, which generates the Make/additiveFoamVersion.H file. This means that installation instructions on website are now out of date. We will get a fix here shortly.

[colemanjs]

@KDSisco, this is should be fixed in #54