-
Notifications
You must be signed in to change notification settings - Fork 2
[EmioLabs] create your own lab: adds section with predefined modules #64
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
HanaeRateau
wants to merge
1
commit into
SofaComplianceRobotics:main
Choose a base branch
from
HanaeRateau:pr_predefinedmodules
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,6 +11,8 @@ import emio_labs_qcm01 from './img/emio-labs-qcm01.png' | |||||
| import emio_labs_qcm02 from './img/emio-labs-qcm02.png' | ||||||
| import emio_labs_qcm03 from './img/emio-labs-qcm03.png' | ||||||
| import emio_labs_input from './img/emio-labs-input.png' | ||||||
| import emio_labs_calibration from './img/sandbox-calibration.png' | ||||||
| import emio_labs_beamresampler from './img/sandbox-beamresampler.png' | ||||||
|
|
||||||
| # Create Your Own Lab | ||||||
|
|
||||||
|
|
@@ -58,9 +60,27 @@ In order to see the lab into Emio Labs, it needs to be located in the directory | |||||
| <img className="centered" src={emio_labs_dashboard} width="70%" alt="Example of a table of contents for the Emio Labs application"/> | ||||||
| <figcaption>The main table of contents of the Emio Labs application shows the labs content of the application.</figcaption> | ||||||
|
|
||||||
| ### Add Python packages | ||||||
| ### Add Python Packages | ||||||
| If you want to install additional Python packages for your lab, follow the steps in [this section](../emio-labs-user-manual#install-python-packages-for-emio-labs). | ||||||
|
|
||||||
| ### Add a Predefined Module | ||||||
|
|
||||||
| Using the <a href="#include">`#include`</a> syntax, you can include files in your markdown file for better resusability and modularity. For example, you can create a file `assets/labs/mylab/parameters.md` containing explanations about parameters you use for your lab and include it in your main markdown file with: | ||||||
|
|
||||||
| ```markdown | ||||||
| #include("assets/labs/mylab/parameters.md") | ||||||
| ``` | ||||||
|
|
||||||
| There are several predefined modules that you can include in your lab and visualize in the *Sandbox* lab. They are located in the `assets/labs/modules` directory: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The "include" could link to the explanation (if moved) |
||||||
| - `assets/labs/modules/calibration.md` : contains the calibration parameters for the robots used in the labs | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| <img className="centered" src={emio_labs_calibration} width="30%" alt="Screenshot of calibration module"/> | ||||||
| <figcaption>Calibration module in the Sandbox lab.</figcaption> | ||||||
|
|
||||||
| - `assets/labs/modules/beam_resampler.md`: contains tools to resample the beam mesh of a leg | ||||||
| <img className="centered" src={emio_labs_beamresampler} width="30%" alt="Screenshot of beam resampler module"/> | ||||||
| <figcaption>Beam resampler module in the Sandbox lab.</figcaption> | ||||||
|
|
||||||
|
|
||||||
| ## Write Your Own Lab in Markdown | ||||||
|
|
||||||
| Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats. | ||||||
|
|
||||||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if this shouldn't be elsewhere. In the markdown syntax section perhaps?