diff --git a/module2/ressources/Makefile b/module2/ressources/Makefile index 8969184f3c4f13f47e3cc200cab7a7ad0f2c8072..0497f06d3827dc2af9ea32e418d640a8efff3ec6 100644 --- a/module2/ressources/Makefile +++ b/module2/ressources/Makefile @@ -1,4 +1,4 @@ -all: emacs_orgmode.md jupyter.md maintaining_a_journal.md gitlab.md gitlab_fr.md rstudio.md rstudio_fr.md video_examples/README.md +all: emacs_orgmode.md jupyter.md maintaining_a_journal.md gitlab.md gitlab_fr.md rstudio.md rstudio_fr.md orgmode_examples/README.md include ../../Makefile.ressources diff --git a/module2/ressources/video_examples/README.md b/module2/ressources/orgmode_examples/README.md similarity index 85% rename from module2/ressources/video_examples/README.md rename to module2/ressources/orgmode_examples/README.md index d01ef47537bf89960f93213a97906a693bbd2efe..466b0fc34da42a80e4399c18bfb5a2245264c917 100644 --- a/module2/ressources/video_examples/README.md +++ b/module2/ressources/orgmode_examples/README.md @@ -1,3 +1,12 @@ +Table of Contents +============================================================== + +- [Examples from the Video](#examples-from-the-video) +- [Other examples](#other-examples) + +Examples from the Video +======================= + In the MOOC video, I quickly demo how org-mode can be used in various contexts. Here are the (sometimes trimmed) corresponding org-files. These documents depend on many other external data files and are not meant to lead to reproducible documents but it will give you an idea of how it can be organized: 1. [journal.org](journal.org): an excerpt (I've only left a few code samples and links to some resources on R, Stats, ...) from my own journal. This is a personal document where everything (meeting notes, hacking, random thoughts, ...) goes by default. Entries are created with the `C-c c` shortcut. @@ -6,10 +15,14 @@ In the MOOC video, I quickly demo how org-mode can be used in various contexts. 4. [labbookseveral.org](labbook_several.org): this is a labbook for a specific project shared by several persons. As a consequence it starts with information about installation, common scripts, has section with notes about all our meetings, a section with information about experiments and an other one about analysis. Entries could have been labeled by who wrote them but there were only a few of us and this information was available in git so we did not bother. In such labbook, it is common to find annotations indicating that such experiment was `:FLAWED:` as it had some issues. 5. [technicalreport.org](technical_report.org): this is a short technical document I wrote after a colleague sent me a PDF describing an experiment he was conducting and asked me about how reproducible I felt it was. It turned out I had to cut and paste the C code from the PDF, then remove all the line numbers and fix syntax, etc. Obviously I got quite different performance results but writing everything in org-mode made it very easy to generate both HTML and PDF and to explicitly explain how the measurements were done. +Other examples +============== + Here are a few links to other kind of examples: - Slides: all my slides for a series of lectures is available here: . Here is a [typical source](https://raw.githubusercontent.com/alegrand/SMPE/master/lectures/lecture_central_limit_theorem.org) and the [resulting PDF](https://raw.githubusercontent.com/alegrand/SMPE/master/lectures/lecture_central_limit_theorem.pdf) - Lucas Schnorr, a colleague, maintains: - a set of templates for various computer science journals/conferences: [IEEE](https://github.com/schnorr/ieeeorg), [Wiley](https://github.com/schnorr/wileyorg), [ACM](https://github.com/schnorr/acmorg), [LNCS](https://github.com/schnorr/llncsorg) - his lecture on programming languages for undergrads: +- John Kitchin is an expert org-mode user and he maintains a very interesting [blog with many interesting tips](http://kitchingroup.cheme.cmu.edu/blog/). You may want to check this [seminar he gave at SciPy](https://www.youtube.com/watch?v=IsSMs-4GlT8&list=FLQp2VLAOlvq142YN3JO3y8w&app=desktop). diff --git a/module2/ressources/video_examples/README.org b/module2/ressources/orgmode_examples/README.org similarity index 88% rename from module2/ressources/video_examples/README.org rename to module2/ressources/orgmode_examples/README.org index e82c575468ac8eeb867b16293c2626f0cac19b2a..f60c2aef8f04bd96303421213d76d285a31426c7 100644 --- a/module2/ressources/video_examples/README.org +++ b/module2/ressources/orgmode_examples/README.org @@ -6,6 +6,12 @@ #+STARTUP: overview indent inlineimages logdrawer #+LANGUAGE: en + +* Table of Contents :TOC: +- [[#examples-from-the-video][Examples from the Video]] +- [[#other-examples][Other examples]] + +* Examples from the Video In the MOOC video, I quickly demo how org-mode can be used in various contexts. Here are the (sometimes trimmed) corresponding org-files. These documents depend on many other external data files @@ -50,6 +56,7 @@ you an idea of how it can be organized: org-mode made it very easy to generate both HTML and PDF and to explicitly explain how the measurements were done. +* Other examples Here are a few links to other kind of examples: - Slides: all my slides for a series of lectures is available here: https://github.com/alegrand/SMPE. Here is a [[https://raw.githubusercontent.com/alegrand/SMPE/master/lectures/lecture_central_limit_theorem.org][typical source]] and the @@ -59,4 +66,8 @@ Here are a few links to other kind of examples: journals/conferences: [[https://github.com/schnorr/ieeeorg][IEEE]], [[https://github.com/schnorr/wileyorg][Wiley]], [[https://github.com/schnorr/acmorg][ACM]], [[https://github.com/schnorr/llncsorg][LNCS]] - his lecture on programming languages for undergrads: https://github.com/schnorr/mlp/tree/master/conteudo +- John Kitchin is an expert org-mode user and he maintains a very + interesting [[http://kitchingroup.cheme.cmu.edu/blog/][blog with many interesting tips]]. You may want to check + this [[https://www.youtube.com/watch?v=IsSMs-4GlT8&list=FLQp2VLAOlvq142YN3JO3y8w&app=desktop][seminar he gave at SciPy]]. + diff --git a/module2/ressources/video_examples/journal.org b/module2/ressources/orgmode_examples/journal.org similarity index 100% rename from module2/ressources/video_examples/journal.org rename to module2/ressources/orgmode_examples/journal.org diff --git a/module2/ressources/video_examples/labbook_several.org b/module2/ressources/orgmode_examples/labbook_several.org similarity index 100% rename from module2/ressources/video_examples/labbook_several.org rename to module2/ressources/orgmode_examples/labbook_several.org diff --git a/module2/ressources/video_examples/labbook_single.org b/module2/ressources/orgmode_examples/labbook_single.org similarity index 100% rename from module2/ressources/video_examples/labbook_single.org rename to module2/ressources/orgmode_examples/labbook_single.org diff --git a/module2/ressources/video_examples/paper.org b/module2/ressources/orgmode_examples/paper.org similarity index 100% rename from module2/ressources/video_examples/paper.org rename to module2/ressources/orgmode_examples/paper.org diff --git a/module2/ressources/video_examples/technical_report.org b/module2/ressources/orgmode_examples/technical_report.org similarity index 100% rename from module2/ressources/video_examples/technical_report.org rename to module2/ressources/orgmode_examples/technical_report.org