Midas documentation: Difference between revisions
| (93 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Pagelinks}} | |||
== | |||
==Documentation organization== | |||
Even after two versions of the Midas documentation, it is still a real challenge to describe the Midas package in a clear, concise and useful way. On this third attempt, we reworked the layout and placed everything on Wiki, hoping that collaborators will be keen to correct, add and improve its content. Feel free to do so by contacting us in case of unclear or incomplete information. | |||
The documentation of the '''MIDAS code''' is still generated by Doxygen and can be found at | |||
[https://daq00.triumf.ca/~daqweb/doc/midas-develop/html/]. | |||
We split the documentation in 4 main sections: '''Installation''', '''Feature listing''', '''Application listing''', '''Online Database'''. | |||
While the first one provides you a means to get Midas up and running, the '''Feature listing''' should highlight what Midas can do and provide some general information on its implementation. | |||
The '''Application listing''' refers to 'system- & user- build' applications that maybe needed during the acquisition. The '''Online Database''' section describes in details the Midas central information database. | |||
Appendices as the last section collect references, and features information assuming that the reader is already familiar with the Midas environment. | |||
A lot of information can be replicated in every section, but we try to minimize it by cross referencing elements between the different sections. | |||
The hope is that once you have found the feature that you need, the involved application and the activation of that feature with its specific online database section will be easily identifiable. | |||
==[[Installation]]== | ==[[Installation]]== | ||
Installation | Although originally Midas was available for all sorts of OS, nowadays we tend to reduce its support to Linux-based, MacOS, and Windows. | ||
This section contains general information and procedure for installation, configuration and examples of basic operation. | |||
[[Installation|'''more...''']] | |||
==[[Feature listing]]== | ==[[Feature listing]]== | ||
Midas provides by default a complete DAQ system, the main features of which comprise: frontend template for acquiring your hardware information, data transfer mechanism to local/remote computer, data logging capability, data analysis framework, data monitoring, full run control, and web interface for experiment control/monitoring. | |||
While each of these features is described, other potentially useful but ''hidden'' options such as sub-run, messages, history, run sequencer, alarms, event notification, etc, may also be essential to your experiment. A list of such features with description, enabling method, and operation is also provided. [[Feature_listing|'''more...''']] | |||
==[[Application listing]]== | ==[[Application listing]]== | ||
Midas comes with a set of applications for monitoring and control of the acquisition system such as a central database editor (odbedit), webserver (mhttpd), data logger (mlogger) etc. This section describes each individual task and link to the corresponding features and online database entry managing such a feature. [[Application_listing|'''more...''']] | |||
==[[Online Database]]== | ==[[Online Database]]== | ||
The online database (ODB) is the DAQ central information hub for a given experiment. It contains all information related to the internal operation of the data acquisition and any user information related to the configuration of the experiment. It is accessible by any Midas client application connected to this experiment, and by the user through a command line application (odbedit) or through a web interface (mhttpd). | |||
Its content is organized with multiple directory levels filled with structure, arrays or single variables. While the user can create new directories reflecting his/her hardware or analysis configuration, there are dedicated directories reserved for the core operation of the system (/SYSTEM/, /RUNINFO/, ...) but they still remain readable by the user. [[Online_Database|'''more...''']] | |||
- | |||
==[[Appendices]]== | |||
* [[Supported Hardware]] | |||
* [[Mac specific information]] | |||
* [[Multi-threading option]] | |||
* [[Event Builder information]] | |||
* [[MIDAS Event Structure]] | |||
* [[Common Parameters to MIDAS Utilities]] | |||
* [[Notes | Miscelleneous notes]] : Notes that need to be incorporated in the documentation. | |||
* [[Features | New Features]] : documented features to be incorporated in the documentation. | |||
== [[Glossary]] == | == [[Glossary]] == | ||
== [ | |||
== [https://midas.triumf.ca/MidasWiki/index.php?title=Special%3AAllPages&from=&to=&namespace=0 All Pages listing] == | |||
Latest revision as of 11:30, 4 August 2023
Documentation organization
Even after two versions of the Midas documentation, it is still a real challenge to describe the Midas package in a clear, concise and useful way. On this third attempt, we reworked the layout and placed everything on Wiki, hoping that collaborators will be keen to correct, add and improve its content. Feel free to do so by contacting us in case of unclear or incomplete information.
The documentation of the MIDAS code is still generated by Doxygen and can be found at [1].
We split the documentation in 4 main sections: Installation, Feature listing, Application listing, Online Database.
While the first one provides you a means to get Midas up and running, the Feature listing should highlight what Midas can do and provide some general information on its implementation.
The Application listing refers to 'system- & user- build' applications that maybe needed during the acquisition. The Online Database section describes in details the Midas central information database.
Appendices as the last section collect references, and features information assuming that the reader is already familiar with the Midas environment.
A lot of information can be replicated in every section, but we try to minimize it by cross referencing elements between the different sections. The hope is that once you have found the feature that you need, the involved application and the activation of that feature with its specific online database section will be easily identifiable.
Installation
Although originally Midas was available for all sorts of OS, nowadays we tend to reduce its support to Linux-based, MacOS, and Windows. This section contains general information and procedure for installation, configuration and examples of basic operation. more...
Feature listing
Midas provides by default a complete DAQ system, the main features of which comprise: frontend template for acquiring your hardware information, data transfer mechanism to local/remote computer, data logging capability, data analysis framework, data monitoring, full run control, and web interface for experiment control/monitoring. While each of these features is described, other potentially useful but hidden options such as sub-run, messages, history, run sequencer, alarms, event notification, etc, may also be essential to your experiment. A list of such features with description, enabling method, and operation is also provided. more...
Application listing
Midas comes with a set of applications for monitoring and control of the acquisition system such as a central database editor (odbedit), webserver (mhttpd), data logger (mlogger) etc. This section describes each individual task and link to the corresponding features and online database entry managing such a feature. more...
Online Database
The online database (ODB) is the DAQ central information hub for a given experiment. It contains all information related to the internal operation of the data acquisition and any user information related to the configuration of the experiment. It is accessible by any Midas client application connected to this experiment, and by the user through a command line application (odbedit) or through a web interface (mhttpd).
Its content is organized with multiple directory levels filled with structure, arrays or single variables. While the user can create new directories reflecting his/her hardware or analysis configuration, there are dedicated directories reserved for the core operation of the system (/SYSTEM/, /RUNINFO/, ...) but they still remain readable by the user. more...
Appendices
- Supported Hardware
- Mac specific information
- Multi-threading option
- Event Builder information
- MIDAS Event Structure
- Common Parameters to MIDAS Utilities
- Miscelleneous notes : Notes that need to be incorporated in the documentation.
- New Features : documented features to be incorporated in the documentation.