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

Get to a "1.0 release" #23

Open
4 of 10 tasks
zur-quin opened this issue May 24, 2023 · 1 comment
Open
4 of 10 tasks

Get to a "1.0 release" #23

zur-quin opened this issue May 24, 2023 · 1 comment

Comments

@zur-quin
Copy link
Collaborator

zur-quin commented May 24, 2023

Work towards a stable, verified, and documented 1.0 release for HydroChrono. Primary tasks include:

  • Documentation:

    • convert existing comments to sphinx comment format,
    • document any undocumented functions/classes (sphinx style),
    • link tests/plots to sphinx generation, update readme.md with important info
  • Verification:

    • verify results for decay tests,
    • verify regular wave tests,
    • verify irregular wave tests
  • Ensure file names consistent:

    • plot files, output files, comparison data files, should all be named consistently (should be done, just need to double check this is true in all cases)
@dav-og
Copy link
Collaborator

dav-og commented Aug 22, 2023

Additional sub-tasks:

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

No branches or pull requests

2 participants