Skip to content

M
mooc-rr-ressources
Commit e4a54ace authored by Arnaud Legrand's avatar Arnaud Legrand
Browse files
Options

Cosmetics

parent 7adc434e
Show whitespace changes
Inline Side-by-side
Showing with 36 additions and 32 deletions
module2/ressources/maintaining_a_journal.html
View file @ e4a54ace
...@@ -4,21 +4,21 @@ ...@@ -4,21 +4,21 @@
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul style="margin:0 0;"> <ul style="margin:0 0;">
<li style="margin-bottom:0;"><a href="#org6a406ba">Some examples of LabBooks provided for inspiration</a></li> <li style="margin-bottom:0;"><a href="#orgc95598e">Some examples of LabBooks provided for inspiration</a></li>
<li style="margin-bottom:0;"><a href="#org58517dc">How to report efficiently (by Martin Quinson)</a> <li style="margin-bottom:0;"><a href="#org51674f0">How to report efficiently (by Martin Quinson)</a>
<ul style="margin:0 0;"> <ul style="margin:0 0;">
<li style="margin-bottom:0;"><a href="#orgfb19a4a">Reporting</a></li> <li style="margin-bottom:0;"><a href="#org976cc9a">Reporting</a></li>
<li style="margin-bottom:0;"><a href="#orgfa83338">Reporting Logistics</a></li> <li style="margin-bottom:0;"><a href="#org5ff6009">Reporting Logistics</a></li>
<li style="margin-bottom:0;"><a href="#orgbd9e450">Reporting Document Organization</a></li> <li style="margin-bottom:0;"><a href="#org50f88a2">Reporting Document Organization</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org6a406ba" class="outline-2"> <div id="outline-container-orgc95598e" class="outline-2">
<h2 id="org6a406ba">Some examples of LabBooks provided for inspiration</h2> <h2 id="orgc95598e">Some examples of LabBooks provided for inspiration</h2>
<div class="outline-text-2" id="text-org6a406ba"> <div class="outline-text-2" id="text-orgc95598e">
<p> <p>
Since a few years, we systematically require any or our students to Since a few years, we systematically require any or our students to
have a laboratory notebook in org-mode. Most of the time, they start have a laboratory notebook in org-mode. Most of the time, they start
...@@ -36,10 +36,12 @@ LabBook</a> and to the <a href="https://framagit.org/lvgx/pfe/blob/master/doc/la ...@@ -36,10 +36,12 @@ LabBook</a> and to the <a href="https://framagit.org/lvgx/pfe/blob/master/doc/la
<li style="margin-bottom:0;">Tom Cornebize is currently a PhD student advised by Arnaud Legrand <li style="margin-bottom:0;">Tom Cornebize is currently a PhD student advised by Arnaud Legrand
and during his MSc, he also heavily <a href="https://github.com/Ezibenroc/simulating_mpi_applications_at_scale">loged his activity on Github</a>.</li> and during his MSc, he also heavily <a href="https://github.com/Ezibenroc/simulating_mpi_applications_at_scale">loged his activity on Github</a>.</li>
<li style="margin-bottom:0;"><a href="https://github.com/schnorr">Lucas Schnorr</a>'s students usually also maintain their journal in a <li style="margin-bottom:0;"><a href="https://github.com/schnorr">Lucas Schnorr</a>'s students usually also maintain their journal in a
very nice way: <a href="https://github.com/taisbellini/aiyra/blob/master/LabBook.org">Tais Bellini's BSc.</a>, <a href="https://github.com/mittmann/hpc/blob/master/LabBook.org">Arthur Krause’s LabBook</a></li> very nice way: <a href="https://github.com/taisbellini/aiyra/blob/master/LabBook.org">Tais Bellini's BSc.</a>, <a href="https://github.com/mittmann/hpc/blob/master/LabBook.org">Arthur Krause's LabBook</a>, <a href="http://www.inf.ufrgs.br/~llnesi/memory_report/MemoryReport.html">Luca
Nesi's LabBook</a>.</li>
<li style="margin-bottom:0;"><a href="https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/">Martin Quinson</a>'s students also follow such conventions: <li style="margin-bottom:0;"><a href="https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/">Martin Quinson</a>'s students also follow such conventions:
<ul class="org-ul"> <ul class="org-ul">
<li style="margin-bottom:0;">Ezequiel Torti Lopez, M2R 2014. <a href="https://github.com/mquinson/simgrid-simpar/blob/master/report.org">Report</a>, with both the data provenance and the data analysis included in appendix.</li> <li style="margin-bottom:0;">Ezequiel Torti Lopez, M2R 2014. <a href="https://github.com/mquinson/simgrid-simpar/blob/master/report.org">Report</a>, with both the data
provenance and the data analysis included in the appendix.</li>
<li style="margin-bottom:0;">Betsegaw Lemma, M2R 2017. <a href="https://github.com/betsegawlemma/internship/blob/master/intern_report.org">LabBook</a></li> <li style="margin-bottom:0;">Betsegaw Lemma, M2R 2017. <a href="https://github.com/betsegawlemma/internship/blob/master/intern_report.org">LabBook</a></li>
<li style="margin-bottom:0;">Gabriel Corona, engineer on SimGrid, 2015-2016. <a href="https://github.com/randomstuff/simgrid-journal/blob/master/journal.org">Journal</a>, <a href="http://www.gabriel.urdhr.fr/tags/simgrid/">Blog (findings)</a>.</li> <li style="margin-bottom:0;">Gabriel Corona, engineer on SimGrid, 2015-2016. <a href="https://github.com/randomstuff/simgrid-journal/blob/master/journal.org">Journal</a>, <a href="http://www.gabriel.urdhr.fr/tags/simgrid/">Blog (findings)</a>.</li>
<li style="margin-bottom:0;">Matthieu Nicolas, engineer on PLM, 2014-2016, <a href="https://github.com/MatthieuNICOLAS/PLM-reporting/blob/master/activity-report.org">Journal</a>.</li> <li style="margin-bottom:0;">Matthieu Nicolas, engineer on PLM, 2014-2016, <a href="https://github.com/MatthieuNICOLAS/PLM-reporting/blob/master/activity-report.org">Journal</a>.</li>
...@@ -54,20 +56,20 @@ convenient. ...@@ -54,20 +56,20 @@ convenient.
</div> </div>
</div> </div>
<div id="outline-container-org58517dc" class="outline-2"> <div id="outline-container-org51674f0" class="outline-2">
<h2 id="org58517dc">How to report efficiently (by Martin Quinson)</h2> <h2 id="org51674f0">How to report efficiently (by Martin Quinson)</h2>
<div class="outline-text-2" id="text-org58517dc"> <div class="outline-text-2" id="text-org51674f0">
<p> <p>
My friend Martin has gathered <a href="https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/">an excellent compendium of information My friend Martin has gathered <a href="https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/">an excellent compendium of information
and references on his webpage to explain his students what he expects and references on his webpage to explain his students what he expects
from them</a>. I'll therefore simply paraphrase him here with the most from them</a>. <b>I'll therefore simply paraphrase him here</b> with the most
important aspects related to reporting but feel free to read the important aspects related to reporting but feel free to read <a href="https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/">the
original version: original version</a>:
</p> </p>
</div> </div>
<div id="outline-container-orgfb19a4a" class="outline-3"> <div id="outline-container-org976cc9a" class="outline-3">
<h3 id="orgfb19a4a">Reporting</h3> <h3 id="org976cc9a">Reporting</h3>
<div class="outline-text-3" id="text-orgfb19a4a"> <div class="outline-text-3" id="text-org976cc9a">
<p> <p>
I ask you to write a little reporting regularly. Depending on the I ask you to write a little reporting regularly. Depending on the
situation, it may be every day, every week or every month. In any situation, it may be every day, every week or every month. In any
...@@ -98,9 +100,9 @@ a choice here). [..] ...@@ -98,9 +100,9 @@ a choice here). [..]
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgfa83338" class="outline-3"> <div id="outline-container-org5ff6009" class="outline-3">
<h3 id="orgfa83338">Reporting Logistics</h3> <h3 id="org5ff6009">Reporting Logistics</h3>
<div class="outline-text-3" id="text-orgfa83338"> <div class="outline-text-3" id="text-org5ff6009">
<p> <p>
Once you're setup with all software installed and somehow configured, Once you're setup with all software installed and somehow configured,
you need to create a reporting file in a place where I can see it and you need to create a reporting file in a place where I can see it and
...@@ -132,9 +134,9 @@ and still lose no information that you would need on Monday morning. ...@@ -132,9 +134,9 @@ and still lose no information that you would need on Monday morning.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgbd9e450" class="outline-3"> <div id="outline-container-org50f88a2" class="outline-3">
<h3 id="orgbd9e450">Reporting Document Organization</h3> <h3 id="org50f88a2">Reporting Document Organization</h3>
<div class="outline-text-3" id="text-orgbd9e450"> <div class="outline-text-3" id="text-org50f88a2">
<p> <p>
Your reporting document should have four main parts: Your reporting document should have four main parts:
</p> </p>
...@@ -226,7 +228,7 @@ At any point, you can see all ongoing TODO items with the following ...@@ -226,7 +228,7 @@ At any point, you can see all ongoing TODO items with the following
keystrokes: "C-c / t". More information on TODOs in orgmode's keystrokes: "C-c / t". More information on TODOs in orgmode's
<a href="http://orgmode.org/manual/TODO-basics.html">documentation</a>. The important thing here is that most TODO items must <a href="http://orgmode.org/manual/TODO-basics.html">documentation</a>. The important thing here is that most TODO items must
only be written in the <i>Journal</i> part (so that we know when they only be written in the <i>Journal</i> part (so that we know when they
occured). occurred).
</p> </p>
<p> <p>
......
module2/ressources/maintaining_a_journal.org
View file @ e4a54ace
...@@ -21,9 +21,11 @@ a few ones: ...@@ -21,9 +21,11 @@ a few ones:
- Tom Cornebize is currently a PhD student advised by Arnaud Legrand - Tom Cornebize is currently a PhD student advised by Arnaud Legrand
and during his MSc, he also heavily [[https://github.com/Ezibenroc/simulating_mpi_applications_at_scale][loged his activity on Github]]. and during his MSc, he also heavily [[https://github.com/Ezibenroc/simulating_mpi_applications_at_scale][loged his activity on Github]].
- [[https://github.com/schnorr][Lucas Schnorr]]'s students usually also maintain their journal in a - [[https://github.com/schnorr][Lucas Schnorr]]'s students usually also maintain their journal in a
very nice way: [[https://github.com/taisbellini/aiyra/blob/master/LabBook.org][Tais Bellini's BSc.]], [[https://github.com/mittmann/hpc/blob/master/LabBook.org][Arthur Krause’s LabBook]] very nice way: [[https://github.com/taisbellini/aiyra/blob/master/LabBook.org][Tais Bellini's BSc.]], [[https://github.com/mittmann/hpc/blob/master/LabBook.org][Arthur Krause's LabBook]], [[http://www.inf.ufrgs.br/~llnesi/memory_report/MemoryReport.html][Luca
Nesi's LabBook]].
- [[https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/][Martin Quinson]]'s students also follow such conventions: - [[https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/][Martin Quinson]]'s students also follow such conventions:
- Ezequiel Torti Lopez, M2R 2014. [[https://github.com/mquinson/simgrid-simpar/blob/master/report.org][Report]], with both the data provenance and the data analysis included in appendix. - Ezequiel Torti Lopez, M2R 2014. [[https://github.com/mquinson/simgrid-simpar/blob/master/report.org][Report]], with both the data
provenance and the data analysis included in the appendix.
- Betsegaw Lemma, M2R 2017. [[https://github.com/betsegawlemma/internship/blob/master/intern_report.org][LabBook]] - Betsegaw Lemma, M2R 2017. [[https://github.com/betsegawlemma/internship/blob/master/intern_report.org][LabBook]]
- Gabriel Corona, engineer on SimGrid, 2015-2016. [[https://github.com/randomstuff/simgrid-journal/blob/master/journal.org][Journal]], [[http://www.gabriel.urdhr.fr/tags/simgrid/][Blog (findings)]]. - Gabriel Corona, engineer on SimGrid, 2015-2016. [[https://github.com/randomstuff/simgrid-journal/blob/master/journal.org][Journal]], [[http://www.gabriel.urdhr.fr/tags/simgrid/][Blog (findings)]].
- Matthieu Nicolas, engineer on PLM, 2014-2016, [[https://github.com/MatthieuNICOLAS/PLM-reporting/blob/master/activity-report.org][Journal]]. - Matthieu Nicolas, engineer on PLM, 2014-2016, [[https://github.com/MatthieuNICOLAS/PLM-reporting/blob/master/activity-report.org][Journal]].
...@@ -35,9 +37,9 @@ convenient. ...@@ -35,9 +37,9 @@ convenient.
* How to report efficiently (by Martin Quinson) * How to report efficiently (by Martin Quinson)
My friend Martin has gathered [[https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/][an excellent compendium of information My friend Martin has gathered [[https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/][an excellent compendium of information
and references on his webpage to explain his students what he expects and references on his webpage to explain his students what he expects
from them]]. I'll therefore simply paraphrase him here with the most from them]]. *I'll therefore simply paraphrase him here* with the most
important aspects related to reporting but feel free to read the important aspects related to reporting but feel free to read [[https://people.irisa.fr/Martin.Quinson/Research/Students/Methodo/][the
original version: original version]]:
** Reporting ** Reporting
I ask you to write a little reporting regularly. Depending on the I ask you to write a little reporting regularly. Depending on the
situation, it may be every day, every week or every month. In any situation, it may be every day, every week or every month. In any
...@@ -159,7 +161,7 @@ At any point, you can see all ongoing TODO items with the following ...@@ -159,7 +161,7 @@ At any point, you can see all ongoing TODO items with the following
keystrokes: "C-c / t". More information on TODOs in orgmode's keystrokes: "C-c / t". More information on TODOs in orgmode's
[[http://orgmode.org/manual/TODO-basics.html][documentation]]. The important thing here is that most TODO items must [[http://orgmode.org/manual/TODO-basics.html][documentation]]. The important thing here is that most TODO items must
only be written in the /Journal/ part (so that we know when they only be written in the /Journal/ part (so that we know when they
occured). occurred).
*Do not edit past entries of your journal*, unless you have very good *Do not edit past entries of your journal*, unless you have very good
reasons. If you must, make sure that you don't lose information about reasons. If you must, make sure that you don't lose information about
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment