Skip to content

Conversation

@teubert
Copy link
Contributor

@teubert teubert commented Aug 22, 2023

Added simulate_to_threshold to example 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.

Nice addition of simulate_to_threshold

"* horizon\n",
"* print\n",
"* progress"
"In the first section we introduced simulating to a set time. For most applications, users are not interested in the system evolution over a certain timeperiod, but instead in simulating to some event of interest.\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
"In the first section we introduced simulating to a set time. For most applications, users are not interested in the system evolution over a certain timeperiod, but instead in simulating to some event of interest.\n",
"In the first section we introduced simulating to a set time. For most applications, users are not interested in the system evolution over a certain time period, but instead in simulating to some event of interest.\n",

"cell_type": "markdown",
"metadata": {},
"source": [
"If you recall, the ThrownObject model is of an object thrown into the air. The model has two events, `impact` and `falling`. In a real prognostic models, these events will likely correspond with some failure, fault, or warning threshold. That said, events can be any event of interest that a user would like to predict. \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
"If you recall, the ThrownObject model is of an object thrown into the air. The model has two events, `impact` and `falling`. In a real prognostic models, these events will likely correspond with some failure, fault, or warning threshold. That said, events can be any event of interest that a user would like to predict. \n",
"If you recall, the ThrownObject model is of an object thrown into the air. The model has two events, `impact` and `falling`. In real prognostic models, these events will likely correspond with some failure, fault, or warning threshold. That said, events can be any event of interest that a user would like to predict. \n",

"cell_type": "markdown",
"metadata": {},
"source": [
"By default, `simulate_to_threshold` simulates until the first event occurs. In this case, that's `falling` (i.e., when the object begins falling). For this model `falling` will always occur before `impact`, but for many models you wont have such a strict ordering of events. \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
"By default, `simulate_to_threshold` simulates until the first event occurs. In this case, that's `falling` (i.e., when the object begins falling). For this model `falling` will always occur before `impact`, but for many models you wont have such a strict ordering of events. \n",
"By default, `simulate_to_threshold` simulates until the first event occurs. In this case, that's `falling` (i.e., when the object begins falling). For this model, `falling` will always occur before `impact`, but for many models you won't have such a strict ordering of events. \n",

"source": [
"By default, `simulate_to_threshold` simulates until the first event occurs. In this case, that's `falling` (i.e., when the object begins falling). For this model `falling` will always occur before `impact`, but for many models you wont have such a strict ordering of events. \n",
"\n",
"For users interested in when a specific event is reached, you can indicate that using the `threshold_keys` argument. For example,"
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
"For users interested in when a specific event is reached, you can indicate that using the `threshold_keys` argument. For example,"
"For users interested in when a specific event is reached, you can indicate which event you'd like to simulate to using the `threshold_keys` argument. For example,"

@teubert teubert merged commit a904490 into dev Aug 24, 2023
@teubert teubert deleted the examples/sim_to_thresh branch August 24, 2023 15:44
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.

3 participants