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

Params Example #100

Merged
merged 2 commits into from
Sep 15, 2023
Merged

Params Example #100

merged 2 commits into from
Sep 15, 2023

Conversation

teubert
Copy link
Contributor

@teubert teubert commented Sep 15, 2023

Add parameters example to 01_Simulation

@github-actions
Copy link

Thank you for opening this PR. Each PR into dev requires a code review. For the code review, look at the following:

  • Reviewer (someone other than author) should look for bugs, efficiency, readability, testing, and coverage in examples (if relevant).
  • Ensure that each PR adding a new feature should include a test verifying that feature.
  • All errors from static analysis must be resolved.
  • Review the test coverage reports (if there is a change) - will be added as comment on PR if there is a change
  • Review the software benchmarking results (if there is a change) - will be added as comment on PR
  • Any added dependencies are included in requirements.txt, setup.py, and dev_guide.rst (this document)
  • All warnings from static analysis must be reviewed and resolved - if deemed appropriate.

Copy link
Contributor

@kjjarvis kjjarvis left a comment

Choose a reason for hiding this comment

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

Looks good!

"cell_type": "markdown",
"metadata": {},
"source": [
"All the previous sections used a model with default settings. This is hardly ever the case. A model will have to be configured to represent the actual system. For example, the BatteryCircuit default parameters are for a 18650 battery tested in the NASA's SHARP lab. If you're using the model for a system other than that one battery, you will need to update the parameters.\n",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"All the previous sections used a model with default settings. This is hardly ever the case. A model will have to be configured to represent the actual system. For example, the BatteryCircuit default parameters are for a 18650 battery tested in the NASA's SHARP lab. If you're using the model for a system other than that one battery, you will need to update the parameters.\n",
"All the previous sections used a model with default settings. This is hardly ever the case. A model will have to be configured to represent the actual system. For example, the BatteryCircuit default parameters are for a 18650 battery tested in NASA's SHARP lab. If you're using the model for a system other than that one battery, you will need to update the parameters.\n",

Copy link
Contributor

Choose a reason for hiding this comment

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

Do you think this is a good place to include a physical/real example? I'm thinking something like, "in the battery model, the parameters include battery capacity ... ". Just a thought. Parameters feel relatively self-explanatory, so I'm okay without including this too

"cell_type": "markdown",
"metadata": {},
"source": [
"You can also set parameters as keyword arguments when instanciating the model, like below. "
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"You can also set parameters as keyword arguments when instanciating the model, like below. "
"You can also set parameters as keyword arguments when instantiating the model, like below. "

@teubert teubert merged commit a4673fc into dev Sep 15, 2023
28 of 30 checks passed
@teubert teubert deleted the examples/parameters branch September 18, 2023 20:13
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