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

Update tutorial documentation to mention need to delete old files #551

Merged

Conversation

jacobcook1995
Copy link
Collaborator

Description

This adds to the example run documentation to mention that files from previous runs need to be deleted otherwise errors can crop up. I thought the easiest way to do that was just to tell users to delete the old directory and install a new one (rather than listing specific files that could be problematic). Let me know if you think this is sensible and whether you think that the flow is okay!

Fixes #543

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Documentation improvement

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

@jacobcook1995 jacobcook1995 linked an issue Sep 6, 2024 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Sep 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.01%. Comparing base (c711fe7) to head (75ace88).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #551   +/-   ##
========================================
  Coverage    95.01%   95.01%           
========================================
  Files           74       74           
  Lines         4235     4235           
========================================
  Hits          4024     4024           
  Misses         211      211           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@hrlai hrlai left a comment

Choose a reason for hiding this comment

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

Both the text to remind users to delete previously generated folder and example bash code to do so worked well, thanks!

Copy link
Collaborator

@davidorme davidorme left a comment

Choose a reason for hiding this comment

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

@jacobcook1995 That's basically fine. The only thing we could say is that the example is (now) setup to always using the explicit out directory. So we could be a bit cleaner and do the install step once and then get people to delete out (or rename it) if they want to run things again. The advantage of this is it sets people up to do repeated runs from the example data so that they can play around with comparing tweaks to the config etc. etc. rather than just nuking everything and starting from an empty clean copy.

@jacobcook1995 jacobcook1995 merged commit ebe3099 into develop Sep 17, 2024
12 checks passed
@jacobcook1995 jacobcook1995 deleted the 544-ve_run-on-example-does-not-output-initial_statenc branch September 17, 2024 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ve_run on example does not output initial_state.nc Unable to run and rerun ve_example
4 participants