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

Added example of reading input file for unoptimized config in 0D solver docs #36

Closed
wants to merge 1 commit into from

Conversation

alexkaiser
Copy link

It was unclear that the json must be opened then passed to the calibrator. Added instructions for reading that file accordingly.

Current situation

Link any open issues or PRs related to this PR. Please ensure that all non-trivial PRs are first tracked and discussed in an existing GitHub issue or discussion.

Release Notes

Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.

Documentation

Please ensure that you properly document any additions.

Testing

Please ensure that the PR meets the testing requirements set by GitHub Actions.

In addition, please ensure all modified and new code is covered by tests.

Code of Conduct & Contributing Guidelines

@ktbolt
Copy link
Contributor

ktbolt commented Nov 22, 2024

@alexkaiser The calibrate function input argument is a Python object, does not need to be read in from a file. The my_unoptimized_config = {...} statement does demonstrate this but it is not very informative.

The svZeroDCalibrator - Quick User Guide should be reorganized to first describe what it does and what data it uses (config file). And after that show an example for Python and C++ how to use calibrate.

@ktbolt
Copy link
Contributor

ktbolt commented Nov 22, 2024

@alexkaiser And an Issue should have been opened for this.

@alexkaiser
Copy link
Author

Okay, please feel free to discard the pull request and change otherwise, for minor changes will open an issue in the future.

@ktbolt
Copy link
Contributor

ktbolt commented Nov 22, 2024

@alexkaiser Thanks for bringing this problem to our attention!

I have opened an Issue for it.

@ktbolt ktbolt closed this Nov 22, 2024
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.

2 participants