{"id":6974,"date":"2018-02-22T14:34:00","date_gmt":"2018-02-22T19:34:00","guid":{"rendered":"http:\/\/irreal.org\/blog\/?p=6974"},"modified":"2018-02-22T14:34:25","modified_gmt":"2018-02-22T19:34:25","slug":"literate-benchmarking","status":"publish","type":"post","link":"https:\/\/irreal.org\/blog\/?p=6974","title":{"rendered":"Literate Benchmarking"},"content":{"rendered":"<p> I&rsquo;ve written several posts that celebrate Org mode for its ability to document various tasks in a literate way, execute the code, and gather the results. The nice thing about this process is that you have everything together: <\/p>\n<ul class=\"org-ul\">\n<li>Documentation of the task;<\/li>\n<li>Code to perform the task;<\/li>\n<li>Results from running the code.<\/li>\n<\/ul>\n<p> They&rsquo;re all in a single file that makes it easy to share and reproduce. <\/p>\n<p> My favorite example of this is Howard Abrams&rsquo; post and video on <a href=\"http:\/\/www.howardism.org\/Technical\/Emacs\/literate-devops.html\">Literate DevOps<\/a>. His presentation is specialized to DevOps but the techniques he uses are easily adaptable to other types of tasks. <\/p>\n<p> Alex Benn\u00e9e has a nice example of using these techniques for <a href=\"https:\/\/www.bennee.com\/~alex\/blog\/2018\/02\/21\/workbooks-for-benchmarking\/\">running benchmarks<\/a>. The problems with running benchmarks are similar to those encountered in DevOps so the same sort of &ldquo;literate&rdquo; solution can be applied. The post doesn&rsquo;t show the entire benchmarking file but Benn\u00e9e does provide a pointer to it. The file is on GitHub and therefore gets reformatted so if you want to see what&rsquo;s really happening, click on the <kbd>Raw<\/kbd> button to see the actual <a href=\"https:\/\/raw.githubusercontent.com\/stsquad\/testcases\/master\/aarch64\/benchmark.org\">Org file<\/a>. <\/p>\n<p> If you&rsquo;ve been a developer for a while, your tendency\u2014or at least mine\u2014is to just run the necessary commands from the command line and be done with it. That&rsquo;s quick and easy but now you have to remember exactly what you did to share the results or to repeat the task at a later date. I&rsquo;ve been making a concerted effort to slow down and do these tasks in a literate fashion using Org mode. The extra time and effort pay off in the end and you can even link to the file from your lab notebook\u2014you <i>are<\/i> keeping one, right?\u2014so that everything is documented. <\/p>\n","protected":false},"excerpt":{"rendered":"<p>I&rsquo;ve written several posts that celebrate Org mode for its ability to document various tasks in a literate way, execute the code, and gather the results. The nice thing about this process is that you have everything together: Documentation of &hellip; <a href=\"https:\/\/irreal.org\/blog\/?p=6974\">Continue reading <span class=\"meta-nav\">&rarr;<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[18,4],"class_list":["post-6974","post","type-post","status-publish","format-standard","hentry","category-general","tag-emacs","tag-org-mode"],"_links":{"self":[{"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/posts\/6974","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=6974"}],"version-history":[{"count":1,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/posts\/6974\/revisions"}],"predecessor-version":[{"id":6975,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/posts\/6974\/revisions\/6975"}],"wp:attachment":[{"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=6974"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=6974"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=6974"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}