Project

General

Profile

User story #1332

MARTe2-tutorials env. setup

Added by André Neto over 2 years ago. Updated 23 days ago.

Status:
New
Priority:
Normal
Assignee:
-
Target version:
-
Start date:
17.11.2022
Due date:
% Done:

100%

Estimated time:
Git branch (link):
Git merge to develop (link):
SVN commit (link/?p=rev):

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:
  1. Clone MARTe2 and change to the branch of this user-story
  2. Add to the MARTe2 online documentation a section named Tutorials and a subsection named Environment
  3. 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
    1. Make sure everything works with the current versions of MARTe2
    2. If there are artifacts in the MARTe2-demos-padova moved them to the MARTe2 repository.
Notes:
  1. To generate the documentation
    1. cd MY_MARTE_LOC/Docs/User/
    2. make html
  2. Open a browser and point to Docs/User/build/html
training_demo.rst (5.09 KB) training_demo.rst Jose Maria Gomez, 19.12.2022 11:51
index.rst (1.36 KB) index.rst Jose Maria Gomez, 20.12.2022 13:23
tutorial.rst (6.02 KB) tutorial.rst Jose Maria Gomez, 20.12.2022 13:23

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

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

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 the tutorial/environment/building.rst page, please: Before the EPICS example, let's add and explain some (easier) examples:
  • 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)

Also available in: Atom PDF