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

Add doc page with input parameters and descriptions #2779

Closed

Conversation

etpalmer63
Copy link
Contributor

Summary

List of input parameters that relate to plotfile output.

Additional background

Checklist

The proposed changes:

  • fix a bug or incorrect behavior in AMReX
  • add new capabilities to AMReX
  • changes answers in the test suite to more than roundoff level
  • are likely to significantly affect the results of downstream AMReX users
  • include documentation in the code and/or rst files, if appropriate

@etpalmer63
Copy link
Contributor Author

A couple input parameter descriptions are incomplete and some may been inaccurate. I am happy to have help from others for the description entries.

@etpalmer63 etpalmer63 marked this pull request as ready for review August 25, 2023 15:07
@etpalmer63
Copy link
Contributor Author

I see this PR as having two issues after reviving it:

  1. It's not part of the table of contents and I don't believe any page in the document currently link to it. So it won't be easy for users to find.
  2. The information may be out of date and should be re-verified.

Thanks!

Erik

@WeiqunZhang
Copy link
Member

I think we should put all parameters into amrex. prefix space. Once that's done, I will redo this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants