mkdocs.yml 14.2 KB
Newer Older
Matias Guijarro's avatar
Matias Guijarro committed
1
2
3
site_name: Bliss documentation
repo_name: 'bliss/bliss'
repo_url: 'https://gitlab.esrf.fr/bliss/bliss'
Matias Guijarro's avatar
Matias Guijarro committed
4
use_directory_urls: false
5
nav:
6
        - Getting started:
7
8
9
10
11
12
13
14
                - About BLISS: index.md
                - BLISS in a nutshell:
                      - Architecture overview: bliss_overview.md
                      - BLISS shell: bliss_shell.md
                      - Motion control basics: bliss_motion_control_basics.md
                      - Counters: bliss_counters.md
                      - Standard scans: bliss_standard_scans.md
                      - Flint, online data visualisation tool: bliss_flint.md
15
                      - Data policy and data format: data/data_nutshell.md
16
17
18
                      - Data life cycle: bliss_data_life.md
                      - "Practical example: slits alignment": bliss_slits_alignment.md
                      - User defined sequences: bliss_user_sequences.md
Matias Guijarro's avatar
Matias Guijarro committed
19
                      - Running BLISS demo session: bliss_demo.md
Linus Pithan's avatar
Linus Pithan committed
20
21
        - Training resources:
                      - Video Tutorials: training_videos.md
22
                      - CheatSheet: doc_cheatsheet.md
Matias Guijarro's avatar
Matias Guijarro committed
23
24
25
        - Installation:
                - Installing at ESRF: installation_esrf.md
                - Installing outside ESRF: installation.md
26
27
28
        - Devices:
                - 2D detectors (Lima): config_lima.md
                - Actuators: config_actuator.md
29
                - AH401: config_ah401.md
30
                - Andeen-Hagerling 2550A capacitance bridge: config_ah2550a.md
Valentin Valls's avatar
Valentin Valls committed
31
                - AH401 picoammeter: config_ah401.md
32
33
34
                - APC: config_apc.md
                - AutoFilter: config_autofilter.md
                - BCDU8: config_bcdu8.md
35
                - Celeroton fast chopper: config_celeroton.md
36
                - CITY: config_city.md
37
38
                - Cold Light Sources:
                      - Intraled: config_intraled.md
39
40
41
42
43
44
45
46
                - Correlators:
                      - Flex: config_correlator_flex.md
                - Diffractometer: using_diffractometer.md
                - Electrometers:
                      - MCCE: config_mcce.md
                - Elettra / ePicea 4 quadrant diode BPM: config_elettra.md
                - Energy and Wavelength: config_enwl.md
                - ESRF BeamViewer (EBV): config_beamviewer.md
47
48
                - Interferometers:
                      - Attocube: config_ids3010.md
49
50
51
                - KB Mirror: config_kb.md
                - Keithley:
                      - Ammeter and Multimeter: config_keithley.md
52
                      - 6487: config_keithley_6487.md
53
                      - 2700: config_keithley_2700.md
54
                      - 428: config_keithley_428.md
55
                      - 3706: config_keithley_3706.md
56
                      - 6487: config_keithley_6487.md
57
58
59
60
61
62
63
64
65
                - Keller: config_keller.md
                - Lecroy: config_lecroy.md
                - Machine info: config_machine.md
                - MCA:
                      - General: config_mca.md
                      - Mythen: config_mythen.md
                      - Rontec: config_mca_rontec.md
                      - XIA: config_xia_mca.md
                - Moco: config_moco.md
Benoit Formet's avatar
Benoit Formet committed
66
                - Monochromators: config_mono.md
67
68
69
70
71
72
73
74
75
76
77
                - Motor controllers:
                      - Aerotech: config_aerotech.md
                      - Attocube: config_attocube.md
                      - Elmo: config_elmo.md
                      - Elmo Whistle: config_elmo_whistle.md
                      - ESRF Hexapode: config_esrf_hexapode.md
                      - Galil: config_galil.md
                      - IcePAP: config_icepap.md
                      - MD2S, MD3: config_md2s_motors.md
                      - Micos: config_micos.md
                      - NewFocus: config_newfocus.md
Cyril Guilloud's avatar
Cyril Guilloud committed
78
                      - Newport XPS: config_xps.md
79
80
81
82
83
84
85
86
                      - PI Hexapod: config_pi_hexa.md
                      - PI Piezo: config_pi_piezo.md
                      - PM600: config_pm600.md
                      - Smaract MCS: config_smaract_mcs1.md
                      - Smaract MCS2: config_smaract_mcs2.md
                      - Symetrie Hexapod: config_shexapod.md
                      - Vscanner: config_vscanner.md
                      - Wago: config_wagomotor.md
bliss administrator's avatar
bliss administrator committed
87
                      - Zaber: config_zaber.md
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
                - Multiple positions: config_mp.md
                - MUSST: config_musst.md
                - Nano-BPM: config_nano_bpm.md
                - Opiom: config_opiom.md
                - P201: config_p201.md
                - PEPU: config_pepu.md
                - Power supply:
                      - Nhq: config_nhq.md
                      - HMC8041: config_hmc8041.md
                - Regulation framework:
                      - Lakeshore: config_lakeshore.md
                      - Linkam: config_linkam.md
                      - Eurotherm Nanodac: config_nanodac.md
                      - Eurotherm2000: config_eurotherm2000.md
                      - Oxford700: config_oxford700.md
                      - Oxford800: config_oxford800.md
                      - PACE: config_pace.md
                - SCA:
                      - Ace: config_ace.md
                      - Cyberstar: config_cyberstar.md
                - Shutters, Frontend and Valves: config_shutter.md
                - Simulation: config_simulation.md
                - Slits: config_slits.md
Perceval Guillou's avatar
Perceval Guillou committed
111
112
                - Spectrometer:
                        - ESRF spectrometer: config_spectrometer.md
113
                - Speedgoat: config_speedgoat.md
114
115
116
117
118
119
120
121
122
123
124
125
126
                - Tripod: config_tab3.md
                - Tango attribute as counters: config_taac.md
                - Tango gauges: config_tg_gauges.md
                - TFG: config_tango_tfg.md
                - Transfocators: config_transfocator.md
                - Transmission: config_transmission.md
                - Undulators: config_undulator.md
                - VME time frame generator: config_tango_tfg.md
                - White beam Attenuator: config_wba.md
                - Wagos:
                      - Wago: config_wago.md
                      - Wago groups: config_wago_group.md
                      - config_wago_interlock.md
Matias Guijarro's avatar
Matias Guijarro committed
127
        - Configuration:
128
129
130
131
132
                - Beacon:
                      - Introduction: beacon.md
                      - Running Beacon: beacon_install.md
                      - YAML files: beacon_db.md
                      - Settings: beacon_settings.md
Cyril Guilloud's avatar
Cyril Guilloud committed
133
                      - Mixed Config and Settings: beacon_object.md
134
135
                      - Channels: beacon_channels.md
                      - Static configuration API: beacon_static_api.md
136
137
                      - Log services: beacon_logservice.md
                      - Web portal: beacon_webportal.md
Cyril Guilloud's avatar
Cyril Guilloud committed
138
                - Sessions:
139
                      - Sessions: config_sessions.md
Linus Pithan's avatar
Linus Pithan committed
140
                      - Aliases: config_alias.md
141
142
                - Shell:
                      - Customize syntax highlighting: config_shell.md
Cyril Guilloud's avatar
Cyril Guilloud committed
143
144
                - BLISS objects:
                      - Object instantiation: config_plugins.md
145
                      - Measurement groups: config_mg.md
146
147
148
149
                - Data:
                      - Data policy: data/config_data_policy.md
                      - Nexus writer: data/config_nexus_writer.md
                      - HDF5: data/config_hdf5.md
150
                - Tango Device Servers:
151
152
                      - Introduction: config_tango_ds.md
                      - BlissAxis: config_tango_axis.md
153
                      - MotorControllerDevice: config_tango_motor_controller.md
154
155
156
157
158
159
160
161
                      - CT2: config_tango_ct2.md
                      - Gpib: config_tango_gpib.md
                      - Keithley: config_tango_keithley.md
                      - LinkamDsc: config_tango_linkamdsc.md
                      - FuelCell: config_tango_fuelcell.md
                      - Musst: config_tango_musst.md
                      - NanoBpm: config_tango_nanobpm.md
                      - Wago device server: config_tango_wago.md
Antonia Beteva's avatar
Antonia Beteva committed
162
                      - MCCE: config_tango_mcce.md
Perceval Guillou's avatar
Perceval Guillou committed
163
                      - Regulation: config_tango_regulation.md
164
                      - Andeen-Hagerling 2550a: config_tango_ah2550a.md
165
                - Deprecated: config_deprecated.md
Cyril Guilloud's avatar
Cyril Guilloud committed
166
        - BLISS shell:
167
168
                - Command line usage: shell_cmdline.md
                - Standard functions: shell_std_func.md
Linus Pithan's avatar
Linus Pithan committed
169
                - Typing helper: shell_typing_helper.md
170
                - Logging: shell_logging.md
171
                - Dialogs: shell_dialogs.md
172
                - Object protection: shell_obj_protection.md
173
174
175
        - Motion:
                - Axis: motion_axis.md
                - Encoder: motion_encoder.md
Lucas Felix's avatar
Lucas Felix committed
176
                - Closed loop: motion_closed_loop.md
177
                - Soft Axis: motion_softaxis.md
Linus Pithan's avatar
Linus Pithan committed
178
                - Hook: motion_hook.md
Benoit Formet's avatar
Benoit Formet committed
179
                - Stack: motion_stack.md
180
                - Trajectories: motion_traj.md
Perceval Guillou's avatar
Perceval Guillou committed
181
182
        - Regulation:
                - Regulation framework (new): regul_regulation_fw.md
Matias Guijarro's avatar
Matias Guijarro committed
183
        - Scanning:
184
                - Measurement groups: config_mg.md
Matias Guijarro's avatar
Matias Guijarro committed
185
                - Default scans: scan_default.md
186
                - Alignment: scan_alignment.md
187
                - Counters on the fly: scan_ctmg.md
Cyril Guilloud's avatar
Cyril Guilloud committed
188
                - BLISS scan engine:
189
                    - Overview: scan_engine.md
190
                    - Scan: scan_engine_scan.md
191
                    - Acquisition chain: scan_engine_acquisition_chain.md
Perceval Guillou's avatar
Perceval Guillou committed
192
                    - Acquisition objects: scan_engine_acquisition_master_and_slaves.md
193
                    - Preset: scan_engine_preset.md
194
                    - Watchdog: scan_engine_watchdog.md
Perceval Guillou's avatar
Perceval Guillou committed
195
                - Custom scans: scan_writing.md
196
                - Grouping scans: scan_group.md
Wout De Nolf's avatar
Wout De Nolf committed
197
        - Data:
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
                - Data policy: data/data_policy.md
                - Configuration:
                    - Data policy: data/config_data_policy.md
                    - Nexus writer: data/config_nexus_writer.md
                    - HDF5: data/config_hdf5.md
                - HDF5:
                    - Access: data/data_hdf5.md
                    - Nexus Format: data/data_nexus.md
                - Metadata:
                    - Scan metadata: data/data_scan_metadata.md
                    - Dataset metadata: data/data_dataset_metadata.md
                    - Logbook: data/data_logbook.md
                - In-memory access:
                    - Low-level API: data/data_redis_api_low.md
                    - High-level API: data/data_redis_api_high.md
Wout De Nolf's avatar
Wout De Nolf committed
213
214
                - Offline visualization:
                    - Warning: data_vis_warning.md
215
                    - Silx-view: data_vis_silx.md
Wout De Nolf's avatar
Wout De Nolf committed
216
                    - Pymca: data_vis_pymca.md
Valentin Valls's avatar
Valentin Valls committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
        - Flint (online visualization):
            - Overview: flint/index.md
            - Live curve: flint/live_curve.md
            - Live image: flint/live_image.md
            - Live scatter: flint/live_scatter.md
            - Live MCA: flint/live_mca.md
            - Other live display: flint/other_live_display.md
            - Custom plotting: flint/flint_data_plotting.md
            - Interactive data selection: flint/flint_interaction.md
            - Editing Lima ROIs: flint/live_image_lima_roi.md
            - Advanced:
                - Startup options: flint/flint_startup_options.md
                - Debugging: flint/flint_debugging.md
                - Custom plot class: flint/flint_custom_plot_class.md
                - Scan info for live display: flint/flint_scan_info.md
                - Live display examples: flint/examples.md
                - Live mesh scan rendering examples: flint/examples_mesh_rendering.md
234
        - Developers corner:
Jibril Mammeri's avatar
Jibril Mammeri committed
235
                - API documentation ⚙: api.md
236
                - Guidelines: dev_guidelines.md
237
                - Writing documentation: dev_documentation.md
Matias Guijarro's avatar
Matias Guijarro committed
238
                - Testing: dev_testing.md
239
                - Communication API: dev_comm.md
Cyril Guilloud's avatar
Cyril Guilloud committed
240
                - BLISS library: bliss_as_library.md
Perceval Guillou's avatar
Perceval Guillou committed
241
242
243
244
245
                - Counters controllers:
                    - Standard counters: dev_counters.md
                    - Calculation counters: dev_calc_counters.md
                - Acquisition objects: dev_acq.md
                - Writing a device controller:
246
247
                    - BLISS controller: dev_write_ctrl.md
                    - Writing a motor controller: dev_write_motctrl.md
Perceval Guillou's avatar
Perceval Guillou committed
248
                    - Writing a calculational motor controller: dev_write_calc_ctrl.md
249
                    - Writing a MCA controller: dev_write_mca.md
Perceval Guillou's avatar
Perceval Guillou committed
250
                    - Writing a shutter controller: dev_write_shutter.md
251
                    - Logging a controller: dev_maplog_controller.md
Perceval Guillou's avatar
Perceval Guillou committed
252
                - User interactions: dev_dialogs.md
253
                - BLISS utils: dev_utils.md
254
                - Session Instance Map: dev_instance_map.md
Linus Pithan's avatar
Linus Pithan committed
255
                - Shell signature hint: dev_shell_signature.md
256
257
                - Tips'n'tricks: dev_tipsntricks.md
                - Dealing with energy: dev_energy.md
258
                - Xia handel: config_mca_handel.md
Linus Pithan's avatar
Linus Pithan committed
259
                - timedisplay: timedisplay.md
260
                - Data:
261
262
263
                    - Architecture: data/dev_data_architecture.md
                    - Publishing: data/dev_data_publishing.md
                    - Subscribing: data/dev_data_subscribing.md
264
                    - Redis structures: data/data_redis.md
265
266
                    - Data nodes: data/data_redis_nodes.md
                    - Data policy: data/dev_data_policy.md
267

Matias Guijarro's avatar
Matias Guijarro committed
268
theme:
269
270
271
272
273
274
275
276
277
278
279
280
281
  name: material
  favicon: img/favicon.png
  language: en
  custom_dir: 'theme'
  palette:
    primary: white
    accent: light blue
  font:
    text: Roboto
    code: 'Roboto Mono'
  logo: 'bliss_logo_small.svg'


Matias Guijarro's avatar
Matias Guijarro committed
282
markdown_extensions:
283
284
285
286
287
  - fenced_code
  - admonition
  - attr_list
  - codehilite

288
  - pymdownx.superfences
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details

  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - smarty
  - toc:
      permalink: true
  - sane_lists
  - mkdocs_graphviz:
     color: 000000
     bgcolor: none

Matias Guijarro's avatar
Matias Guijarro committed
313
extra_javascript:
314
  - 'https://cdn.jsdelivr.net/gh/rod2ik/cdn@main/mkdocs/javascripts/mkdocs-graphviz.js'
Matias Guijarro's avatar
Matias Guijarro committed
315
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
Matias Guijarro's avatar
Matias Guijarro committed
316
  - redirect.js