From 79efc5daa265551410e33f5a89bf94ae3f538236 Mon Sep 17 00:00:00 2001 From: Teresia Olsson Date: Thu, 24 Sep 2026 16:18:48 +0200 Subject: [PATCH 1/3] Added a tip to highlight that using the dynamic catalog is the recommended option. --- docs/source/explanation/catalog.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/explanation/catalog.md b/docs/source/explanation/catalog.md index 1055360..754e697 100644 --- a/docs/source/explanation/catalog.md +++ b/docs/source/explanation/catalog.md @@ -16,7 +16,9 @@ The catalog makes it possible to use simple keys in the pyAML configuration and ## Dynamic Catalog +```{tip} The dynamic catalog does not require a configuration file and it is therefore the recommended option for most use cases. +``` In this version, the configuration is extracted from a dynamic source. This can be directly from the control system or some other source, for example a database, depending on the chosen backend and its catalog implementation. From 8a31ec6cfc51e7bcd475ba181cb7e8ba96ef2ba9 Mon Sep 17 00:00:00 2001 From: Teresia Olsson Date: Thu, 24 Sep 2026 16:30:40 +0200 Subject: [PATCH 2/3] List classes for static catalog in tango-pyaml as a list. --- docs/source/explanation/catalog.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/explanation/catalog.md b/docs/source/explanation/catalog.md index 754e697..a8c8d9c 100644 --- a/docs/source/explanation/catalog.md +++ b/docs/source/explanation/catalog.md @@ -61,7 +61,7 @@ controls: catalog: fodo_1gev_6d_pyaml_catalogs-oa.yaml ``` -Example of a static catalog file for `pyaml-cs-oa`, with one entry: +Example of a static catalog file for `pyaml-cs-oa` with a single entry: ```yaml class: pyaml_cs_oa.static_catalog.StaticCatalog @@ -74,6 +74,9 @@ entries: unit: 1/m ``` -The same catalog for `tango-pyaml` uses the classes of that package (`tango.pyaml.static_catalog.StaticCatalog`, `tango.pyaml.static_catalog_entry.StaticCatalogEntry` and `tango.pyaml.attribute.Attribute`). +The static catalog for `tango-pyaml` uses the corresponding classes for that package: +- `tango.pyaml.static_catalog.StaticCatalog` +- `tango.pyaml.static_catalog_entry.StaticCatalogEntry` +- `tango.pyaml.attribute.Attribute` This format follows the same syntax as for the rest of the pyAML configuration since during the loading process the file is read and the content added to the rest of the pyAML configuration. \ No newline at end of file From 9d1b0bb94da61a3b5e3333ba88c0a2475003d48e Mon Sep 17 00:00:00 2001 From: Teresia Olsson Date: Thu, 24 Sep 2026 18:36:47 +0200 Subject: [PATCH 3/3] Updated info and config examples for the dynamic catalog. --- docs/source/explanation/catalog.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/source/explanation/catalog.md b/docs/source/explanation/catalog.md index a8c8d9c..f449245 100644 --- a/docs/source/explanation/catalog.md +++ b/docs/source/explanation/catalog.md @@ -24,27 +24,26 @@ In this version, the configuration is extracted from a dynamic source. This can This requires access to the source, for example by being on the same network, but no configuration file for the control system configuration has to be loaded by pyAML. -Example of configuration for dynamic catalog: +Example of configuration for dynamic catalog for the `pyaml-cs-oa` bindings : ```yaml controls: - class: pyaml_cs_oa.controlsystem.OphydAsyncControlSystem name: live - catalog: - class: pyaml_cs_oa.dynamic_catalog.DynamicCatalog - backend: tango + backend: tango ``` -With `pyaml-cs-oa`, a dynamic catalog is also used when no catalog is given, based on the `backend` field of the control system: +The backend (currently TANGO or EPICS) is specified using the `backend` field. + +For the `tango-pyaml` bindings no backend needs to be specified: ```yaml controls: - - class: pyaml_cs_oa.controlsystem.OphydAsyncControlSystem + - class: tango.pyaml.tango_catalog.TangoCatalog name: live - backend: tango ``` -Dynamic catalogs are currently provided by `pyaml-cs-oa`. Check the documentation of your control-system bindings for the catalogs they support. +Check the [API documentation](../reference/index.md) for all the options for the bindings you want to use. ## Static Catalog