Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes from round of JOSS review #428

Merged
merged 6 commits into from
Nov 4, 2024
Merged

Changes from round of JOSS review #428

merged 6 commits into from
Nov 4, 2024

Conversation

Yurlungur
Copy link
Collaborator

PR Summary

This is to address comments in #427 . Thanks @guadabsb15 for the suggestions!

  • Add discussion of sanity checks to getting started
  • Make build/bin more consistent in documentation
  • Add comment about python path
  • Make sure figures display in all browsers by making png versions

PR Checklist

  • Adds a test for any bugs fixed. Adds tests for new features.
  • Format your changes by using the make format command after configuring with cmake.
  • Document any new features, update documentation for changes made.
  • Make sure the copyright notice on any files you modified is up to date.
  • After creating a pull request, note it in the CHANGELOG.md file.
  • LANL employees: make sure tests pass both on the github CI and on the Darwin CI

If preparing for a new release, in addition please check the following:

  • Update the version in cmake.
  • Move the changes in the CHANGELOG.md file under a new header for the new release, and reset the categories.
  • Ensure that any when='@main' dependencies are updated to the release version in the package.py

- Add discussion of sanity checks to getting started
- Make build/bin more consistent in documentation
- Add comment about python path
- Make sure figures display in all browsers by making png versions
@Yurlungur Yurlungur added the documentation Improvements or additions to documentation label Oct 30, 2024
@Yurlungur Yurlungur self-assigned this Oct 30, 2024
@Yurlungur Yurlungur linked an issue Oct 30, 2024 that may be closed by this pull request
@Yurlungur Yurlungur mentioned this pull request Oct 30, 2024
cmake -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF ..
make -j
make install # optional: install into directory defined via CMAKE_INSTALL_PREFIX
cmake -B builddir -S . -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF -DSINGULARITY_BUILD_EXAMPLES=ON -DSINGULARITY_BUILD_TESTS=ON

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this buildidir should be build? just like the ones on line 13 and 14. I saw there was a change in name and probably that one was forgotten.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, my mistake!

Comment on lines 13 to 14
cmake --build build --parallel
cmake --install build # optional: install into directory defined via CMAKE_INSTALL_PREFIX
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cmake --build build --parallel
cmake --install build # optional: install into directory defined via CMAKE_INSTALL_PREFIX
cmake --build builddir --parallel
cmake --install builddir # optional: install into directory defined via CMAKE_INSTALL_PREFIX

@Yurlungur
Copy link
Collaborator Author

Changed things back to builddir and did a consistency sweep through the docs. Hopefully I got them all now. I also removed the unit tests from getting started.

@Yurlungur Yurlungur merged commit dc8f306 into main Nov 4, 2024
6 checks passed
@Yurlungur Yurlungur deleted the jmm/joss-comments branch November 4, 2024 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JOSS review comments
4 participants