Skip to content

Unified examples - #348

Draft
gubaidulinvadim wants to merge 2 commits into
mainfrom
unified-examples
Draft

Unified examples#348
gubaidulinvadim wants to merge 2 commits into
mainfrom
unified-examples

Conversation

@gubaidulinvadim

Copy link
Copy Markdown
Member

Unified examples for ESRF, BESSY II and SOLEIL II in thematic notebooks for each large use case.
Only the configuration file now needs to be swapped to run the same example. This will help to avoid having some examples that work and some that do not because of recent changes in the code. And we will only need to modify a single example valid for all facilities instead of many slightly different ones. Old examples will be deleted if we agree on these unified examples.

Resolves #182
Resolves #170 as the path is now different (and the problem was maybe already nonexistent)
Resolves #171 as the new examples were checked to be running without errors

for each large use case.
Only the configuration file now needs to be swapped to run the same
example. This will help to avoid having some examples that work and some
that do not because of recent changes in the code.
Old examples will be deleted if we agree on these unified examples.
@gubaidulinvadim gubaidulinvadim self-assigned this Aug 14, 2026
@gubaidulinvadim gubaidulinvadim added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 14, 2026
@JeanLucPons

Copy link
Copy Markdown
Member

Thanks for this unification !
For the ESRF side you can remove the following files that are more for unit tests.

[ubuntu20acu.pons] > tree
.
├── catalogs
│   ├── ebs_bpm_catalogs.yaml
│   ├── ebs_catalogs.yaml
│   ├── ebs_diag_catalogs.yaml
│   ├── ebs_magnets_catalogs.yaml
│   ├── ebs_rf_catalogs.yaml
│   ├── ebs_sext_catalogs.yaml
│   ├── ebs_sh_catalogs.yaml
│   └── sr_catalogs.yaml  # REMOVE
├── esrf.yaml
├── sr
│   ├── arrays # REMOVE
│   ├── correctors # REMOVE
│   │   ├── SH1AC01-C02.yaml # REMOVE
│   │   ├── SH1AC01-ident.yaml # REMOVE
│   │   ├── SH1AC01-range.yaml # REMOVE
│   │   ├── SH1AC01.yaml # REMOVE
│   │   └── SH1AC02.yaml # REMOVE
│   ├── custom_magnets # REMOVE
│   │   └── hidcorr.yaml # REMOVE
│   ├── lattices
│   │   ├── ebs.mat
│   │   └── ebs-original-names.mat # REMOVE
│   ├── magnet_models
│   │   ├── QD2_strength.csv
│   │   ├── QF1AC01.json # REMOVE
│   │   ├── QF1AC01.yaml # REMOVE
│   │   ├── QF1_strength.csv
│   │   ├── QF6_strength.csv
│   │   ├── quadcurve_data.json # REMOVE
│   │   ├── quadcurve_data.yaml # REMOVE
│   │   ├── quadcurve.json # REMOVE
│   │   ├── quadcurve.yaml # REMOVE
│   │   ├── serialized_strength.csv # REMOVE
│   │   ├── SH1AC01-ident.yaml # REMOVE
│   │   ├── SH1AC01-range.yaml # REMOVE
│   │   ├── SH1AC01.yaml # REMOVE
│   │   ├── SH1AC02.yaml # REMOVE
│   │   ├── SH1_SH3_h_strength.csv
│   │   ├── SH1_SH3_sq_strength.csv
│   │   ├── SH1_SH3_v_strength.csv
│   │   ├── SH2_h_strength.csv
│   │   ├── SH2_sq_strength.csv
│   │   ├── SH2_v_strength.csv
│   │   ├── SHI_h_strength.csv
│   │   ├── SHI_matrix.csv
│   │   ├── SHI_sext_strength.csv
│   │   ├── SHI_sq_strength.csv
│   │   ├── SHI_v_strength.csv
│   │   └── SH_matrix.csv
│   ├── QF1.yaml # REMOVE
│   └── quadrupoles # REMOVE
│       ├── QD5D-C04_serialized.yaml # REMOVE
│       ├── QF1AC01-IDENT-HW.yaml # REMOVE
│       ├── QF1AC01-IDENT-STRGTH.yaml # REMOVE
│       ├── QF1AC01.json # REMOVE
│       ├── QF1AC01.yaml # REMOVE
│       └── QF1C01A_2.yaml # REMOVE
└── trm.json

@gubaidulinvadim
gubaidulinvadim marked this pull request as draft August 14, 2026 13:08
@gubaidulinvadim

Copy link
Copy Markdown
Member Author

I converted to draft because I will need to remove some config files and old examples before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: Universal Examples ESRF cases for pyAML - few findings Path in example is wrong

2 participants