mkdocs.yml 12.5 KB
Newer Older
Matias Guijarro's avatar
Matias Guijarro committed
1
2
site_name: Bliss documentation
repo_name: 'bliss/bliss'
Valentin Valls's avatar
Valentin Valls committed
3
site_url: ''
Matias Guijarro's avatar
Matias Guijarro committed
4
repo_url: 'https://gitlab.esrf.fr/bliss/bliss'
Matias Guijarro's avatar
Matias Guijarro committed
5
use_directory_urls: false
6
nav:
7
        - Getting started:
8
9
10
11
12
13
14
15
16
17
18
19
                - 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
                      - Data policy and data format: bliss_data_policy.md
                      - 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
20
                      - Running BLISS demo session: bliss_demo.md
Linus Pithan's avatar
Linus Pithan committed
21
22
        - Training resources:
                      - Video Tutorials: training_videos.md
23
                      - CheatSheet: doc_cheatsheet.md
Matias Guijarro's avatar
Matias Guijarro committed
24
25
26
        - Installation:
                - Installing at ESRF: installation_esrf.md
                - Installing outside ESRF: installation.md
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
        - Devices:
                - 2D detectors (Lima): config_lima.md
                - Actuators: config_actuator.md
                - APC: config_apc.md
                - AutoFilter: config_autofilter.md
                - BCDU8: config_bcdu8.md
                - CITY: config_city.md
                - 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
                - KB Mirror: config_kb.md
                - Keithley:
                      - Ammeter and Multimeter: config_keithley.md
                      - 428: config_keithley_428.md
                      - Keithley 3706: config_keithley_3706.md
                - 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
                - 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
                      - 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
                - 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
                - Tripod: config_tab3.md
                - Tango attribute as counters: config_taac.md
                - Tango gauges: config_tg_gauges.md
                - Temperature framework:
                      - Meerstetter: config_meerstetter.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
113
        - Configuration:
114
115
116
117
118
                - 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
119
                      - Mixed Config and Settings: beacon_object.md
120
121
                      - Channels: beacon_channels.md
                      - Static configuration API: beacon_static_api.md
122
123
                      - Log services: beacon_logservice.md
                      - Web portal: beacon_webportal.md
Cyril Guilloud's avatar
Cyril Guilloud committed
124
                - Sessions:
125
                      - Sessions: config_sessions.md
Linus Pithan's avatar
Linus Pithan committed
126
                      - Aliases: config_alias.md
Cyril Guilloud's avatar
Cyril Guilloud committed
127
128
129

                - BLISS objects:
                      - Object instantiation: config_plugins.md
130
                      - Measurement groups: config_mg.md
Linus Pithan's avatar
Linus Pithan committed
131
132
                - Data Policy:
                      - ICAT Meta-Data: dev_icat.md
133
                - Tango Device Servers:
134
135
136
137
138
139
140
141
142
143
144
                      - Introduction: config_tango_ds.md
                      - BlissAxis: config_tango_axis.md
                      - 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
                      - NanoDac: config_tango_nanodac.md
                      - Wago device server: config_tango_wago.md
145
                - Deprecated: config_deprecated.md
Cyril Guilloud's avatar
Cyril Guilloud committed
146
        - BLISS shell:
147
148
                - Command line usage: shell_cmdline.md
                - Standard functions: shell_std_func.md
Linus Pithan's avatar
Linus Pithan committed
149
                - Typing helper: shell_typing_helper.md
150
                - Logging: shell_logging.md
151
                - Dialogs: shell_dialogs.md
152
                - Object protection: shell_obj_protection.md
153
154
155
        - Motion:
                - Axis: motion_axis.md
                - Encoder: motion_encoder.md
156
                - Soft Axis: motion_softaxis.md
Linus Pithan's avatar
Linus Pithan committed
157
                - Hook: motion_hook.md
Benoit Formet's avatar
Benoit Formet committed
158
                - Stack: motion_stack.md
159
                - Trajectories: motion_traj.md
Perceval Guillou's avatar
Perceval Guillou committed
160
161
162
        - Regulation:
                - Regulation framework (new): regul_regulation_fw.md
                - Temperature framework (old): regul_temperature_fw.md
Matias Guijarro's avatar
Matias Guijarro committed
163
        - Scanning:
164
                - Measurement groups: config_mg.md
Matias Guijarro's avatar
Matias Guijarro committed
165
                - Default scans: scan_default.md
166
                - Alignment: scan_alignment.md
167
                - Counters on the fly: scan_ctmg.md
Cyril Guilloud's avatar
Cyril Guilloud committed
168
                - BLISS scan engine:
169
                    - Overview: scan_engine.md
170
                    - Scan: scan_engine_scan.md
171
172
173
                    - Acquisition chain: scan_engine_acquisition_chain.md
                    - Acquisition Master/Device: scan_engine_acquisition_master_and_devices.md
                    - Preset: scan_engine_preset.md
174
                    - Watchdog: scan_engine_watchdog.md
175
                    - Data node: scan_data_node.md
Perceval Guillou's avatar
Perceval Guillou committed
176
                - Custom scans: scan_writing.md
177
                - Grouping scans: scan_group.md
Wout De Nolf's avatar
Wout De Nolf committed
178
179
180
181
        - Data:
                - Data policy: data_policy.md
                - Data format: data_nexus_format.md
                - Metadata: data_metadata.md
182
                - Online visualization:
Valentin Valls's avatar
Valentin Valls committed
183
                    - Flint: flint/flint.md
184
                    - Startup options: flint/flint_startup_options.md
185
186
187
188
189
                    - Live scans: flint/flint_scan_plotting.md
                    - Custom data plotting: flint/flint_data_plotting.md
                    - Data selection: flint/flint_interaction.md
                    - Editing Lima ROI counters: flint/flint_roi_counters.md
                    - Debugging: flint/flint_debugging.md
Wout De Nolf's avatar
Wout De Nolf committed
190
191
                - Offline visualization:
                    - Warning: data_vis_warning.md
192
                    - Silx-view: data_vis_silx.md
Wout De Nolf's avatar
Wout De Nolf committed
193
                    - Pymca: data_vis_pymca.md
194
        - Developers corner:
Jibril Mammeri's avatar
Jibril Mammeri committed
195
                - API documentation ⚙: api.md
196
                - Guidelines: dev_guidelines.md
197
                - Writing documentation: dev_documentation.md
Matias Guijarro's avatar
Matias Guijarro committed
198
                - Testing: dev_testing.md
199
                - Communication API: dev_comm.md
Cyril Guilloud's avatar
Cyril Guilloud committed
200
                - BLISS library: bliss_as_library.md
Cyril Guilloud's avatar
Cyril Guilloud committed
201
                - BLISS controller: dev_write_ctrl.md
202
                - Writing a motor controller: dev_write_motctrl.md
Cyril Guilloud's avatar
Cyril Guilloud committed
203
                - Writing a calculational controller: dev_write_calc_ctrl.md
204
205
                - Writing a MCA controller: dev_write_mca.md
                - Writing a temperature controller: dev_write_tempctrl.md
206
                - Logging a controller: dev_maplog_controller.md
207
                - Integrate dialogs: dev_dialogs.md
208
                - BLISS utils: dev_utils.md
209
                - Writing a shutter: dev_write_shutter.md
210
                - Session Instance Map: dev_instance_map.md
Cyril Guilloud's avatar
Cyril Guilloud committed
211
212
213
                - Counters:
                      - counters: dev_ct.md
                      - Calc Counters: dev_calc_counters.md
214
                - Acquisition objects: dev_acq.md
Linus Pithan's avatar
Linus Pithan committed
215
                - Shell signature hint: dev_shell_signature.md
216
217
                - Tips'n'tricks: dev_tipsntricks.md
                - Dealing with energy: dev_energy.md
218
                - Xia handel: config_mca_handel.md
Linus Pithan's avatar
Linus Pithan committed
219
                - Speedgoat: config_speedgoat.md
Linus Pithan's avatar
Linus Pithan committed
220
                - timedisplay: timedisplay.md
Linus Pithan's avatar
Linus Pithan committed
221
                - Dataset handling: dev_data_set.md
222
                - Data:
223
224
225
                    - Architecture: dev_data_architecture.md
                    - Publishing: dev_data_publishing.md
                    - Subscribing: dev_data_subscribing.md
Wout De Nolf's avatar
Wout De Nolf committed
226
                    - Data policy:
227
228
229
                        - Basic: dev_data_policy_basic.md
                        - Custom: dev_data_policy_custom.md
                    - Nexus writer: dev_data_nexus_server.md
Valentin Valls's avatar
Valentin Valls committed
230
231
232
                    - Writing scans to display it on Flint:
                        - Scan info: flint/flint_scan_info.md
                        - Examples: flint/flint_scan_info_examples.md
233
                    - Metadata: dev_data_metadata.md
234

Matias Guijarro's avatar
Matias Guijarro committed
235
236
theme:
        name: material
237
        favicon: img/favicon.png
Matias Guijarro's avatar
Matias Guijarro committed
238
        language: en
239
        custom_dir: 'theme'
Matias Guijarro's avatar
Matias Guijarro committed
240
        palette:
241
242
                primary: white
                accent: light blue
Matias Guijarro's avatar
Matias Guijarro committed
243
244
245
        font:
                text: Roboto
                code: 'Roboto Mono'
246
        logo: 'bliss_logo_small.svg'
Matias Guijarro's avatar
Matias Guijarro committed
247
248
markdown_extensions:
        - admonition
249
        - attr_list
Matias Guijarro's avatar
Matias Guijarro committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
        - codehilite
        - 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.superfences
        - pymdownx.tasklist:
            custom_checkbox: true
        - pymdownx.tilde
Matias Guijarro's avatar
Matias Guijarro committed
267
268
269
270
        - smarty
        - toc:
                permalink: true
        - sane_lists
271
        - mdx_inline_graphviz
Matias Guijarro's avatar
Matias Guijarro committed
272
273
extra_javascript:
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
Matias Guijarro's avatar
Matias Guijarro committed
274
  - redirect.js