lemke_handClaude Sonnet 5
16a0cb0faf
- Remove det_jf: now that det_diff was fixed to JF01T03V01 (previous commit), det_jf was a second device pointing at the same physical Jungfrau, otherwise unreferenced anywhere. - Add bernina.dummy (DummyMexicanHat): x, y (DummyAdjustable) + imex (DetectorGet reading a live 2D Mexican-hat signal of their current values, (1-r^2)*exp(-r^2/2), r=sqrt(x^2+y^2) -- stays within [-1, 1] for any x, y, small Gaussian noise by default). No real hardware; for testing grid-scan / live 2D counter-grid machinery. - Fix Scans.meshscan(..., repetitions=N>1): grid_specs["index_plan"] is built once, for a single pass over the grid, before StepScan.__init__ repeats `values`/`pulses_per_step` by `repetitions` -- so do_next_step()'s gridspecs["index_plan"][self.next_step] indexed past the end (IndexError) the moment the scan entered its second repetition. Now repeats index_plan the same way. - Add scripts/eco-escape-test: like eco-dev, but also prepends a sibling escape-fel checkout to PYTHONPATH (assumed to live next to this eco checkout), for testing local checkouts of both together instead of whatever's installed. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
eco — Experiment Control
___ _______
/ -_) __/ _ \
Experiment Control \__/\__/\___/
eco is a Python-based control environment for experiments, developed and used at SwissFEL, PSI. It is used both as:
- a library of experimental devices for higher-level Python applications or GUIs, and
- an interactive command-line interface, e.g. from an IPython/Jupyter shell or notebook.
eco follows an object-oriented approach: every device is represented as a Python object with a small, predictable interface, so devices can be freely combined in generic control/acquisition routines and analysed with the scientific Python ecosystem. For a general introduction to object-oriented Python, see e.g. this short introduction.
Documentation
The full documentation — installation, core concepts, and worked examples (listening monitors, archiver data and strip charts, pipeline offload, motor configuration) — lives in docs/ and is built with Sphinx, configured to build on Read the Docs via .readthedocs.yaml.
Build it locally:
pip install -r docs/requirements.txt
sphinx-build -b html docs docs/_build/html
Installation
conda install -c paulscherrerinstitute eco
or, for development, in editable mode from a checkout:
git clone https://github.com/paulscherrerinstitute/eco.git
cd eco
pip install -e .
See Installation for beamline-specific setup (the
eco launcher, .ecorc defaults) and the full dependency picture.
Creating a new device
New devices are implemented as a subclass of Assembly, which provides
naming, aliasing, and shell representation:
from eco.elements.assembly import Assembly
class MyDevice(Assembly):
def __init__(self, name=None):
super().__init__(name=name)
self._append(MySubObject, name="my_sub_object", is_setting=True, is_status=True)
is_setting=True marks the child as a setting of the assembly (shown by
.settings() and captured when settings are saved); is_status=True marks it
as contributing to the assembly's .status(). See
Representing real devices — the Assembly in the full docs
for the rest of the model (Adjustable, Detector, Namespace) and a
from-scratch, runnable example of each.