Skip to content

Commit 65da37b

Browse files
jennantennlee
andauthored
Named pipelines, | operator and reverse pipeline (#173)
* add name to pipeline and allow retrieval os sub-pipelines using their names * add a property to reverse the effects of a pipeline * allow using | operator to combine pipelines * store pipeline name in steps * Add named pipe demo * implement pipeline reverse as an Operation instead of a Pipeline * add ReversedPipeline in the API docs * add patterns notebook to the gallery --------- Co-authored-by: Tennessee Leeuwenburg <[email protected]>
1 parent 1b5f894 commit 65da37b

6 files changed

Lines changed: 6138 additions & 11 deletions

File tree

docs/api/pipeline/pipeline_api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
:members:
1111
.. autoclass:: pyearthtools.pipeline.Operation
1212
:members:
13+
.. autoclass:: pyearthtools.pipeline.ReversedPipeline
14+
:members:
1315
.. autoclass:: pyearthtools.pipeline.PipelineException
1416
:members:
1517
.. autoclass:: pyearthtools.pipeline.PipelineFilterException

docs/api/pipeline/pipeline_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ The rest of this page contains reference information for the components of the P
66

77
| Module | Purpose | API Docs |
88
|----------------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------|
9-
| `pipeline` | | - [Sampler](pipeline_api.md#pyearthtools.pipeline.Sampler) |
9+
| `pipeline` | | - [Sampler](pipeline_api.md#pyearthtools.pipeline.Sampler) |
1010
| | | - [Pipeline](pipeline_api.md#pyearthtools.pipeline.Pipeline) |
1111
| | | - [Operation](pipeline_api.md#pyearthtools.pipeline.Operation) |
12+
| | | - [ReversedPipeline](pipeline_api.md#pyearthtools.pipeline.ReversedPipeline) |
1213
| | | - [PipelineException](pipeline_api.md#pyearthtools.pipeline.PipelineException) |
1314
| | | - [PipelineFilterException](pipeline_api.md#pyearthtools.pipeline.PipelineFilterException) |
1415
| | | - [PipelineRuntimeError](pipeline_api.md#pyearthtools.pipeline.PipelineRuntimeError) |

notebooks/Gallery.ipynb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@
115115
"| Basics | Introduction to what a pipeline is (essential reading) | [Pipeline Basics](./pipeline/Basics.ipynb) | 18 Aug 2025 |\n",
116116
"| Operations | Introduction to pipeline operations | [Pipeline Operations](./pipeline/Operations.ipynb) | 18 Aug 2025 |\n",
117117
"| Modifications | Introduction to pipeline modifications | [Pipeline Modifications](./pipeline/Modifications.ipynb) | 22 Aug 2025 |\n",
118-
"| Branching | -- | [Pipeline Branching](./pipeline/Branching.ipynb) | 18 Aug 2025 |\n"
118+
"| Branching | -- | [Pipeline Branching](./pipeline/Branching.ipynb) | 18 Aug 2025 |\n",
119+
"| Patterns | Recommended design patterns for pipelines | [Additional Pipeline Syntaxes](./pipeline/Patterns.ipynb) | 21 Oct 2025 |\n"
119120
]
120121
}
121122
],
@@ -135,7 +136,7 @@
135136
"name": "python",
136137
"nbconvert_exporter": "python",
137138
"pygments_lexer": "ipython3",
138-
"version": "3.13.5"
139+
"version": "3.13.7"
139140
}
140141
},
141142
"nbformat": 4,

0 commit comments

Comments
 (0)