SFB-onboarding.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. <!DOCTYPE html>
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
  3. <meta charset="utf-8">
  4. <meta name="generator" content="quarto-1.3.433">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  6. <title>Gin onboarding</title>
  7. <style>
  8. code{white-space: pre-wrap;}
  9. span.smallcaps{font-variant: small-caps;}
  10. div.columns{display: flex; gap: min(4vw, 1.5em);}
  11. div.column{flex: auto; overflow-x: auto;}
  12. div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
  13. ul.task-list{list-style: none;}
  14. ul.task-list li input[type="checkbox"] {
  15. width: 0.8em;
  16. margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
  17. vertical-align: middle;
  18. }
  19. </style>
  20. <script src="SFB-onboarding_files/libs/clipboard/clipboard.min.js"></script>
  21. <script src="SFB-onboarding_files/libs/quarto-html/quarto.js"></script>
  22. <script src="SFB-onboarding_files/libs/quarto-html/popper.min.js"></script>
  23. <script src="SFB-onboarding_files/libs/quarto-html/tippy.umd.min.js"></script>
  24. <script src="SFB-onboarding_files/libs/quarto-html/anchor.min.js"></script>
  25. <link href="SFB-onboarding_files/libs/quarto-html/tippy.css" rel="stylesheet">
  26. <link href="SFB-onboarding_files/libs/quarto-html/quarto-syntax-highlighting.css" rel="stylesheet" id="quarto-text-highlighting-styles">
  27. <script src="SFB-onboarding_files/libs/bootstrap/bootstrap.min.js"></script>
  28. <link href="SFB-onboarding_files/libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
  29. <link href="SFB-onboarding_files/libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light">
  30. </head>
  31. <body class="fullcontent">
  32. <div id="quarto-content" class="page-columns page-rows-contents page-layout-article">
  33. <main class="content" id="quarto-document-content">
  34. <header id="title-block-header" class="quarto-title-block default">
  35. <div class="quarto-title">
  36. <h1 class="title">Gin onboarding</h1>
  37. </div>
  38. <div class="quarto-title-meta">
  39. </div>
  40. </header>
  41. <section id="ice-breaking" class="level1">
  42. <h1>1. Ice breaking</h1>
  43. <p>Please tell your name, group and something you achieved this week.</p>
  44. <blockquote class="blockquote">
  45. <p>Julien Colomb, INF project, I recently passed my Aikido 3.Kyu exam.</p>
  46. </blockquote>
  47. </section>
  48. <section id="why-gin-tonic" class="level1">
  49. <h1>2. Why GIN-Tonic</h1>
  50. <ul>
  51. <li>Data science approach: work using code, work in a team, work online</li>
  52. <li>Research project:
  53. <ul>
  54. <li>Git version control + project management tool</li>
  55. <li>Research repository template</li>
  56. <li>Special toolbox for many and large files</li>
  57. </ul></li>
  58. <li>DMP: one text file to manage and share</li>
  59. </ul>
  60. </section>
  61. <section id="getting-a-gin-account" class="level1">
  62. <h1>3. Getting a GIN account</h1>
  63. <ul>
  64. <li><a href="https://gindata.biologie.hu-berlin.de/user/sign_up" class="uri">https://gindata.biologie.hu-berlin.de/user/sign_up</a></li>
  65. <li>write username and group to the data manager (zoom chat/ email)</li>
  66. <li>The data manager will add you to the organisation prepared for your team</li>
  67. <li><a href="https://gindata.biologie.hu-berlin.de" class="uri">https://gindata.biologie.hu-berlin.de</a> &gt;&gt; sign in</li>
  68. </ul>
  69. </section>
  70. <section id="create-a-new-project" class="level1">
  71. <h1>4. Create a new project</h1>
  72. <ul>
  73. <li>https://gindata.biologie.hu-berlin.de</li>
  74. <li><code>Access tonic functions</code> button at bottom</li>
  75. <li>project creation</li>
  76. <li>Click on figure “Project creation” - sign in - erase organisation if there is one - choose organisation (dropdown menu) - Write title (no space) - push <code>submit</code> button</li>
  77. </ul>
  78. </section>
  79. <section id="upload-and-modify-dmp-file" class="level1">
  80. <h1>5. Upload and modify DMP file</h1>
  81. <ul>
  82. <li><p>click explore button, search for “INF”</p></li>
  83. <li><p>choose the “<a href="https://gindata.biologie.hu-berlin.de/PRitter_lab/SFB1315_INF.06_dissemination"><strong>PRitter_lab / SFB1315_INF.06_dissemination</strong></a><strong>“</strong> repository (public repository)</p></li>
  84. <li><blockquote class="blockquote">
  85. <blockquote class="blockquote">
  86. <p><code>other</code> folder &gt;&gt; DMP_template.md</p>
  87. </blockquote>
  88. </blockquote></li>
  89. <li><p>click <code>download</code>button</p></li>
  90. <li><p>One person project:</p>
  91. <ul>
  92. <li>go to your research repository</li>
  93. <li>01_project_management &gt;&gt; 05_data_management_plan &gt;&gt; click <code>upload file</code> button</li>
  94. <li>choose DMP file and upload it.</li>
  95. <li>Click the file, modify it,. save it pushing the <code>Commit Changes</code>button</li>
  96. </ul></li>
  97. </ul>
  98. </section>
  99. <section id="some-comments" class="level1">
  100. <h1>6. Some comments</h1>
  101. <ul>
  102. <li>research project = multiple repositories.
  103. <ul>
  104. <li>many files is therefore possible</li>
  105. <li>different sharing of content (organisation, access right, publication)</li>
  106. </ul></li>
  107. </ul>
  108. </section>
  109. <section id="next-steps" class="level1">
  110. <h1>7. Next steps</h1>
  111. <ul>
  112. <li>Desktop version to work with (large) datasets</li>
  113. <li>basics of datalad and git</li>
  114. </ul>
  115. </section>
  116. </main>
  117. <!-- /main column -->
  118. <script id="quarto-html-after-body" type="application/javascript">
  119. window.document.addEventListener("DOMContentLoaded", function (event) {
  120. const toggleBodyColorMode = (bsSheetEl) => {
  121. const mode = bsSheetEl.getAttribute("data-mode");
  122. const bodyEl = window.document.querySelector("body");
  123. if (mode === "dark") {
  124. bodyEl.classList.add("quarto-dark");
  125. bodyEl.classList.remove("quarto-light");
  126. } else {
  127. bodyEl.classList.add("quarto-light");
  128. bodyEl.classList.remove("quarto-dark");
  129. }
  130. }
  131. const toggleBodyColorPrimary = () => {
  132. const bsSheetEl = window.document.querySelector("link#quarto-bootstrap");
  133. if (bsSheetEl) {
  134. toggleBodyColorMode(bsSheetEl);
  135. }
  136. }
  137. toggleBodyColorPrimary();
  138. const icon = "";
  139. const anchorJS = new window.AnchorJS();
  140. anchorJS.options = {
  141. placement: 'right',
  142. icon: icon
  143. };
  144. anchorJS.add('.anchored');
  145. const isCodeAnnotation = (el) => {
  146. for (const clz of el.classList) {
  147. if (clz.startsWith('code-annotation-')) {
  148. return true;
  149. }
  150. }
  151. return false;
  152. }
  153. const clipboard = new window.ClipboardJS('.code-copy-button', {
  154. text: function(trigger) {
  155. const codeEl = trigger.previousElementSibling.cloneNode(true);
  156. for (const childEl of codeEl.children) {
  157. if (isCodeAnnotation(childEl)) {
  158. childEl.remove();
  159. }
  160. }
  161. return codeEl.innerText;
  162. }
  163. });
  164. clipboard.on('success', function(e) {
  165. // button target
  166. const button = e.trigger;
  167. // don't keep focus
  168. button.blur();
  169. // flash "checked"
  170. button.classList.add('code-copy-button-checked');
  171. var currentTitle = button.getAttribute("title");
  172. button.setAttribute("title", "Copied!");
  173. let tooltip;
  174. if (window.bootstrap) {
  175. button.setAttribute("data-bs-toggle", "tooltip");
  176. button.setAttribute("data-bs-placement", "left");
  177. button.setAttribute("data-bs-title", "Copied!");
  178. tooltip = new bootstrap.Tooltip(button,
  179. { trigger: "manual",
  180. customClass: "code-copy-button-tooltip",
  181. offset: [0, -8]});
  182. tooltip.show();
  183. }
  184. setTimeout(function() {
  185. if (tooltip) {
  186. tooltip.hide();
  187. button.removeAttribute("data-bs-title");
  188. button.removeAttribute("data-bs-toggle");
  189. button.removeAttribute("data-bs-placement");
  190. }
  191. button.setAttribute("title", currentTitle);
  192. button.classList.remove('code-copy-button-checked');
  193. }, 1000);
  194. // clear code selection
  195. e.clearSelection();
  196. });
  197. function tippyHover(el, contentFn) {
  198. const config = {
  199. allowHTML: true,
  200. content: contentFn,
  201. maxWidth: 500,
  202. delay: 100,
  203. arrow: false,
  204. appendTo: function(el) {
  205. return el.parentElement;
  206. },
  207. interactive: true,
  208. interactiveBorder: 10,
  209. theme: 'quarto',
  210. placement: 'bottom-start'
  211. };
  212. window.tippy(el, config);
  213. }
  214. const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
  215. for (var i=0; i<noterefs.length; i++) {
  216. const ref = noterefs[i];
  217. tippyHover(ref, function() {
  218. // use id or data attribute instead here
  219. let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
  220. try { href = new URL(href).hash; } catch {}
  221. const id = href.replace(/^#\/?/, "");
  222. const note = window.document.getElementById(id);
  223. return note.innerHTML;
  224. });
  225. }
  226. let selectedAnnoteEl;
  227. const selectorForAnnotation = ( cell, annotation) => {
  228. let cellAttr = 'data-code-cell="' + cell + '"';
  229. let lineAttr = 'data-code-annotation="' + annotation + '"';
  230. const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
  231. return selector;
  232. }
  233. const selectCodeLines = (annoteEl) => {
  234. const doc = window.document;
  235. const targetCell = annoteEl.getAttribute("data-target-cell");
  236. const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
  237. const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
  238. const lines = annoteSpan.getAttribute("data-code-lines").split(",");
  239. const lineIds = lines.map((line) => {
  240. return targetCell + "-" + line;
  241. })
  242. let top = null;
  243. let height = null;
  244. let parent = null;
  245. if (lineIds.length > 0) {
  246. //compute the position of the single el (top and bottom and make a div)
  247. const el = window.document.getElementById(lineIds[0]);
  248. top = el.offsetTop;
  249. height = el.offsetHeight;
  250. parent = el.parentElement.parentElement;
  251. if (lineIds.length > 1) {
  252. const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
  253. const bottom = lastEl.offsetTop + lastEl.offsetHeight;
  254. height = bottom - top;
  255. }
  256. if (top !== null && height !== null && parent !== null) {
  257. // cook up a div (if necessary) and position it
  258. let div = window.document.getElementById("code-annotation-line-highlight");
  259. if (div === null) {
  260. div = window.document.createElement("div");
  261. div.setAttribute("id", "code-annotation-line-highlight");
  262. div.style.position = 'absolute';
  263. parent.appendChild(div);
  264. }
  265. div.style.top = top - 2 + "px";
  266. div.style.height = height + 4 + "px";
  267. let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
  268. if (gutterDiv === null) {
  269. gutterDiv = window.document.createElement("div");
  270. gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
  271. gutterDiv.style.position = 'absolute';
  272. const codeCell = window.document.getElementById(targetCell);
  273. const gutter = codeCell.querySelector('.code-annotation-gutter');
  274. gutter.appendChild(gutterDiv);
  275. }
  276. gutterDiv.style.top = top - 2 + "px";
  277. gutterDiv.style.height = height + 4 + "px";
  278. }
  279. selectedAnnoteEl = annoteEl;
  280. }
  281. };
  282. const unselectCodeLines = () => {
  283. const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
  284. elementsIds.forEach((elId) => {
  285. const div = window.document.getElementById(elId);
  286. if (div) {
  287. div.remove();
  288. }
  289. });
  290. selectedAnnoteEl = undefined;
  291. };
  292. // Attach click handler to the DT
  293. const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
  294. for (const annoteDlNode of annoteDls) {
  295. annoteDlNode.addEventListener('click', (event) => {
  296. const clickedEl = event.target;
  297. if (clickedEl !== selectedAnnoteEl) {
  298. unselectCodeLines();
  299. const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
  300. if (activeEl) {
  301. activeEl.classList.remove('code-annotation-active');
  302. }
  303. selectCodeLines(clickedEl);
  304. clickedEl.classList.add('code-annotation-active');
  305. } else {
  306. // Unselect the line
  307. unselectCodeLines();
  308. clickedEl.classList.remove('code-annotation-active');
  309. }
  310. });
  311. }
  312. const findCites = (el) => {
  313. const parentEl = el.parentElement;
  314. if (parentEl) {
  315. const cites = parentEl.dataset.cites;
  316. if (cites) {
  317. return {
  318. el,
  319. cites: cites.split(' ')
  320. };
  321. } else {
  322. return findCites(el.parentElement)
  323. }
  324. } else {
  325. return undefined;
  326. }
  327. };
  328. var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
  329. for (var i=0; i<bibliorefs.length; i++) {
  330. const ref = bibliorefs[i];
  331. const citeInfo = findCites(ref);
  332. if (citeInfo) {
  333. tippyHover(citeInfo.el, function() {
  334. var popup = window.document.createElement('div');
  335. citeInfo.cites.forEach(function(cite) {
  336. var citeDiv = window.document.createElement('div');
  337. citeDiv.classList.add('hanging-indent');
  338. citeDiv.classList.add('csl-entry');
  339. var biblioDiv = window.document.getElementById('ref-' + cite);
  340. if (biblioDiv) {
  341. citeDiv.innerHTML = biblioDiv.innerHTML;
  342. }
  343. popup.appendChild(citeDiv);
  344. });
  345. return popup.innerHTML;
  346. });
  347. }
  348. }
  349. });
  350. </script>
  351. </div> <!-- /content -->
  352. </body></html>