Skip to content

Commit

Permalink
Merge pull request #123 from Green-Software-Foundation/add-time-info
Browse files Browse the repository at this point in the history
add info on time sync position in pipelines
  • Loading branch information
narekhovhannisyan authored Dec 9, 2024
2 parents c57c22c + ccf227d commit 9aad440
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/major-concepts/time.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@ This process yields synchronized time series for all components across a tree, e
## Toggling off time sync

Some applications will not want to pad with zero values, and may be strict about continuous time series' being provided in the raw manifest file. In these cases, simply toggle the padding off in the manifest file.

## Time sync in your pipelines

Time sync can run anywhere in your pipeline, but we recommend positioning it as the first plugin in your pipelines wherever possible. This is because running time-sync early means it has to operate over fewer parameters, making the execution more efficient. By running it first, you pass a fully sync'd time series to all the other plugins in the pipeline, minimizing the amount of filling, interpolation and extrapolation that is done on your data.

However, you might find your specific use-case requires time-sync to execute in some specific position in the pipeline - this is fine except you must be aware that your final results can change depending on where time-sync sits in the pipeline because it changes how much of your data is generated directly by subsequent plugins and how much is generated by time-sync.

0 comments on commit 9aad440

Please sign in to comment.