aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/pipeline_input_context/configuration_and_connection.md
diff options
context:
space:
mode:
authorThéo de la Hogue2024-04-22 15:06:50 +0200
committerThéo de la Hogue2024-04-22 15:06:50 +0200
commitc0cd527c8977ad56102f86ec9daecea10db901c6 (patch)
treed838ea1eb56910116f513dd45eb09e6810f1400f /docs/user_guide/pipeline_input_context/configuration_and_connection.md
parent81e6bbf2e4b4c9ba93690dc0989cbf5686243b03 (diff)
parente7344955a1368c24c55fc12b2cb9ff2582278785 (diff)
downloadargaze-c0cd527c8977ad56102f86ec9daecea10db901c6.zip
argaze-c0cd527c8977ad56102f86ec9daecea10db901c6.tar.gz
argaze-c0cd527c8977ad56102f86ec9daecea10db901c6.tar.bz2
argaze-c0cd527c8977ad56102f86ec9daecea10db901c6.tar.xz
Merge doc/update branch.
Diffstat (limited to 'docs/user_guide/pipeline_input_context/configuration_and_connection.md')
-rw-r--r--docs/user_guide/pipeline_input_context/configuration_and_connection.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/user_guide/pipeline_input_context/configuration_and_connection.md b/docs/user_guide/pipeline_input_context/configuration_and_connection.md
new file mode 100644
index 0000000..392860f
--- /dev/null
+++ b/docs/user_guide/pipeline_input_context/configuration_and_connection.md
@@ -0,0 +1,35 @@
+Load and connect a context
+==========================
+
+Once an [ArContext is defined](context_definition.md), it have to be connected to a pipeline.
+
+# Load JSON configuration file
+
+An [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) can be loaded from a JSON configuration file thanks to the argaze.load package method.
+
+Here is a JSON configuration file related to the [previously defined Example context](context_definition.md):
+
+```json
+{
+ "my_context.Example": {
+ "name": "My example context",
+ "parameter": ...,
+ "pipeline": "pipeline.json"
+ }
+}
+```
+
+Then, here is how to load the JSON file:
+
+```python
+import argaze
+
+# Load ArContext
+with argaze.load('./configuration.json') as ar_context:
+
+ # Do something with ArContext
+ ...
+```
+
+!!! note
+ There is nothing to do to execute a loaded context as it is handled inside its own **__enter__** method.