User story #1332
MARTe2-tutorials env. setup
100%
Description
Write instructions on how to prepare the environment to run the tutorials. These instructions will be released as part of the MARTe2 online help (https://vcis.f4e.europa.eu/marte2-docs/master/html/) which is based on Sphinx
Work:- Clone MARTe2 and change to the branch of this user-story
- Add to the MARTe2 online documentation a section named
Tutorials
and a subsection namedEnvironment
- Inside the
Environment
section add/modify the instructions from the demo that are available here: https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-demos-padova- Make sure everything works with the current versions of MARTe2
- If there are artifacts in the
MARTe2-demos-padova
moved them to theMARTe2
repository.
- To generate the documentation
cd MY_MARTE_LOC/Docs/User/
make html
- Open a browser and point to
Docs/User/build/html
History
#1 Updated by André Neto over 2 years ago
- Status changed from New to Code: Impl
#2 Updated by André Neto over 2 years ago
- Assignee set to Jose Maria Gomez
#3 Updated by Jose Maria Gomez over 2 years ago
- File training_demo.rst training_demo.rst added
Some changes were needed in the instructions to make it run. The new instructions are included in 'training_demo.rst'
NOTE: Since no root access was granted, some commands could not be run - such as the 'yum' or 'iptables'
NOTE: The Sphinx sources are located in
/home/jgomez/MARTe2/Docs/User/source.
The builds are in
/home/jgomez/MARTe2/Docs/User/build/html
For building, use the command:
sphinx-build -b html . /home/jgomez/MARTe2/Docs/User/build
#4 Updated by Jose Maria Gomez over 2 years ago
- % Done changed from 0 to 50
#5 Updated by Jose Maria Gomez over 2 years ago
- % Done changed from 50 to 100
- File tutorial.rst tutorial.rst added
- File index.rst index.rst added
New branch MARTe2 -> 1332_MARTe2_tutorials_env_setup created. Creted folder ./tutorial inside /sources. Files tutorial.rst and index.rst created/modified
NOTE: The command necessary for building sphinx was:
sphinx-build -a -b html . /home/jgomez/MARTe2/Docs/User/build/html
If -a was not used, only index.html got updated, but not the other files. So when they were accessed, the frame in the left with all the links to the different parts of the tutorial didn't show the newly created "tutorial".
#6 Updated by André Neto almost 2 years ago
Comments for commit 82271f198093d5ef5fc3bbe6a7e5d91784a03e99:
In thetutorial/environment/building.rst
page, please:
- Remove the reference to the SDN (as it is only meaningful for environments with CCS)
- By the way - SDN - is the ITER Synchronous Databus (real-time) Network - https://www.iter.org/doc/www/content/com/Lists/ITER%20Technical%20Reports/Attachments/15/ITR_20_009_Plant_Control_Design_Handbook_v1.pdf
- Instead, for the demos, we can now use the portable UDPDataSource implementation (https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-components/-/tree/master/Source/Components/DataSources/UDP)
- (The SDN is also based on UDP)
- Add a small description and a reference to the MDSplus page https://www.mdsplus.org/index.php/Introduction
- A MARTe application that reads from a LinuxTimer and prints the Counter and the Time to a LoggerDataSource at a fixed frequency of 2 Hz;
- A MARTe application that reads from a LinuxTimer, executes a WaveformSin and prints the value of the sine to a LoggerDataSource at a fixed frequency of 10 Hz;
- A MARTe application that reads from a LinuxTimer, executes a WaveformSin and stores the value of the sine to a FileDataSource;
- A MARTe application that reads from a LinuxTimer, reads the values from a file (using the FileDataSource), use the MathExpressionGAM to modify these values (e.g. by multiplying them by 2) and then stores the values to a FileDataSource;
- A MARTe application with two threads communicating between them using the RealTimeThreadSynchronisation DataSource.
- The first RealTimeThread is driven by a LinuxTimer running at a frequency of 100 Hz;
- The second RealTimeThread prints the value of the counter at a sub-frequency of 1 Hz (Samples = 100).
- A MARTe application - driven by a LinuxTimer at 10 Hz - that uses the HistogramGAM to compute statistics about the thread cycle time and outputs to the LoggerDataSource.
- A MARTe application with the same structure of the EPICS application (example 1), but without the
EPICS::EPICSCAClient
.
#7 Updated by André Neto 23 days ago
- Status changed from Code: Impl to New
#8 Updated by André Neto 23 days ago
- Assignee deleted (
Jose Maria Gomez)