Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Elliot First <elliot.first@gmail.com>
Co-authored-by: Garry Bowlin <171296429+gbowlin@users.noreply.github.com>
  • Loading branch information
3 people authored Jul 25, 2024
1 parent d264fd9 commit f05486b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ the model's name and any configured thresholds. It is typically defined in a
Modifying the Analysis Data
---------------------------

When possible it can be better to modify the data during extraction and have predictions and events files contain everything that is needed for analysis.
When possible it is better to supplement the data upstream from seismometer such as during data extraction and have predictions and events files contain everything that is needed for analysis.
However, there will inevitably be times when this is not possible but you still want transformations to be done prior to most of the notebook running.

In this situation, you should modify the first cell of your notebook to run a custom startup method instead of ``run_startup``.
Expand All @@ -519,7 +519,7 @@ Then, follow the pattern of normal startup but specify your function in the :py:
from seismometer.configuration import ConfigProvider
from seismometer.data.loader import loader_factory
from seismometer.seismogram import Seismogram
import seismometer._api as sm
def my_startup(config_path="."):
config = ConfigProvider(config_path)
loader = loader_factory(config, post_load_fn=custom_post_load_fn)
Expand Down

0 comments on commit f05486b

Please sign in to comment.