index.html

<!doctype html>
<html lang="en" dir="ltr" class="plugin-pages plugin-id-default" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.7.0">
<title data-rh="true">Welcome to Best Practices &amp; Guidelines | Best Practices &amp; Guidelines</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://swissdatasciencecenter.github.io/best-practice-documentation/img/sdsc.svg"><meta data-rh="true" name="twitter:image" content="https://swissdatasciencecenter.github.io/best-practice-documentation/img/sdsc.svg"><meta data-rh="true" property="og:url" content="https://swissdatasciencecenter.github.io/best-practice-documentation/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Welcome to Best Practices &amp; Guidelines | Best Practices &amp; Guidelines"><meta data-rh="true" name="description" content="Open Source Best Practices &amp; Guidelines"><meta data-rh="true" property="og:description" content="Open Source Best Practices &amp; Guidelines"><link data-rh="true" rel="icon" href="/best-practice-documentation/img/sdsc-favicon.svg"><link data-rh="true" rel="canonical" href="https://swissdatasciencecenter.github.io/best-practice-documentation/"><link data-rh="true" rel="alternate" href="https://swissdatasciencecenter.github.io/best-practice-documentation/" hreflang="en"><link data-rh="true" rel="alternate" href="https://swissdatasciencecenter.github.io/best-practice-documentation/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n   <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n   <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n   <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/best-practice-documentation/</span> </p>\n   <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",(function(){void 0===window.docusaurus&&insertBanner()}))</script><link rel="alternate" type="application/rss+xml" href="/best-practice-documentation/blog/rss.xml" title="Best Practices &amp; Guidelines RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/best-practice-documentation/blog/atom.xml" title="Best Practices &amp; Guidelines Atom Feed"><link rel="stylesheet" href="/best-practice-documentation/assets/css/styles.38e3cdd4.css">
<script src="/best-practice-documentation/assets/js/runtime~main.03e4dda8.js" defer="defer"></script>
<script src="/best-practice-documentation/assets/js/main.ade2d532.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/best-practice-documentation/img/sdsc-logo.svg"><link rel="preload" as="image" href="/best-practice-documentation/assets/images/continuous-improvement-04efd67882fea7d94600516b83777906.jpg"><link rel="preload" as="image" href="/best-practice-documentation/assets/images/adaptability-840d0be092669ca908fbc2908785a9a0.jpg"><link rel="preload" as="image" href="/best-practice-documentation/assets/images/collaboration-f394d3844155e8237380c954ce51d262.jpg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/best-practice-documentation/"><div class="navbar__logo"><img src="/best-practice-documentation/img/sdsc-logo.svg" alt="img/sdsc-logo.svg" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/best-practice-documentation/img/sdsc-logo.svg" alt="img/sdsc-logo.svg" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">SDSC - Best Practices</b></a><a class="navbar__item navbar__link" href="/best-practice-documentation/docs/chapters/intro">Chapters</a><a class="navbar__item navbar__link" href="/best-practice-documentation/docs/contribute/intro">Contribute</a><a class="navbar__item navbar__link" href="/best-practice-documentation/docs/tags">Tags</a><a class="navbar__item navbar__link" href="/best-practice-documentation/blog">News</a></div><div class="navbar__items navbar__items--right"><a href="https://gitlab.datascience.ch/sdsc-best-practices/documentation" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Source<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><header class="hero hero--primary heroBanner_qdFl"><div class="container"><h1 class="hero__title">Best Practices &amp; Guidelines</h1><p class="hero__subtitle"></p></div></header><main><div class="container text--left margin-bottom--lg margin-top--lg"><h1>Vision</h1><p>The goal of this documentation is to promote <strong>excellence</strong> <!-- -->in the fields where the<!-- --> <a href="www.datascience.ch">Swiss Data Science Center</a> is active. It also serves as a resource to foster<!-- --> <strong>curiosity and encouragement</strong> in an ever-evolving technological landscape.</p><h2>Audience</h2><p>This documentation targets (research) software-developer and data-scientists.</p><h2>Updates</h2><p>This documentation is under continuous development. For news on major content updates see the <a href="/best-practice-documentation/blog">newest posts.</a> <!-- -->We might also allow direct contributions from externals in future.<!-- --> </p></div><section class="features_t9lD"><div class="container"><div class="row"><div class="col col--4"><div class="text--center"><img src="/best-practice-documentation/assets/images/continuous-improvement-04efd67882fea7d94600516b83777906.jpg" class="featureSvg_GfXr with-borders" role="img"></div><div class="text--center padding-horiz--md"><h3>Continuous Improvement</h3><p class="text--justify">Continuous learning helps developers stay current with new technologies, write better code, and refine their skills.</p></div></div><div class="col col--4"><div class="text--center"><img src="/best-practice-documentation/assets/images/adaptability-840d0be092669ca908fbc2908785a9a0.jpg" class="featureSvg_GfXr with-borders" role="img"></div><div class="text--center padding-horiz--md"><h3>Adaptability</h3><p class="text--justify">Embracing best practices enhances adaptability, improves problem-solving, and supports long-term career growth.</p></div></div><div class="col col--4"><div class="text--center"><img src="/best-practice-documentation/assets/images/collaboration-f394d3844155e8237380c954ce51d262.jpg" class="featureSvg_GfXr with-borders" role="img"></div><div class="text--center padding-horiz--md"><h3>Collaboration</h3><p class="text--justify">Following industry best practices fosters teamwork through shared knowledge, clearer code, and better communication.</p></div></div></div></div></section></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">SDSC</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://gitlab.datascience.ch/sdsc-best-practices/documentation" target="_blank" rel="noopener noreferrer" class="footer__link-item">Documentation Source<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://datascience.ch" target="_blank" rel="noopener noreferrer" class="footer__link-item">SDSC Homepage<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Content</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/best-practice-documentation/docs/chapters/how-to-cite">How To Cite?</a></li><li class="footer__item"><a class="footer__link-item" href="/best-practice-documentation/docs/chapters/how-to-cite">License</a></li><li class="footer__item"><a class="footer__link-item" href="/best-practice-documentation/docs/chapters/tags">Recommended Tags</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/swiss-data-science-center-sdsc" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/sdscdatascience" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Development</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/best-practice-documentation/docs/team">BPA Team</a></li><li class="footer__item"><a href="https://gitlab.datascience.ch/sdsc-best-practices/documentation/-/pipelines" target="_blank" rel="noopener noreferrer" class="footer__link-item">BPA CI<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 - SDSC</div></div></div></footer></div>
</body>
</html>