This page describes our reproducibility requirements for ''all'' projects and theses supervised by someone from our group.

<<TableOfContents(2)>>

= Access to our SVN, one of our machines, and our file system =

Right after the very first meeting with your supervisor you will be assigned the following. If for some reason, this does not happen within a day, you should send an email to your supervisor ''and'' our system adminstrator [[https://ad.informatik.uni-freiburg.de/staff/dal-ri|Frank Dal-Ri]].

{{{#!html
<p style="color: darkblue">
1. A <b>subfolder in our SVN</b> with URL https://ad-svn.informatik.uni-freiburg.de/student-[projects|theses]/&lt;firstname&gt;-&lt;lastname&gt;. Authentication works via your RZ Account (initials + number).</p>

<p style="color: darkblue">
2. The <b>name of one of our machines</b>, on which you can work. Authentication works via your Informatik Account (first seven letters of your family name + first leter of your given name). This is the username referred to in the next two items.</p>

<p style="color: darkblue">
3. A <b>directory /local/data/&lt;username&gt;</b> for large datasets on a local disk of the machine which you have been assigned. The local disks are fast, so this is great for IO-heavy code (for example, a search engine which frequently reads large segments of data from disk). This directory will be deleted, once you have given your presentation and received your grade.</p>

<p style="color: darkblue">
4. A <b>directory /nfs/students/&lt;username&gt;</b> for large datasets on our network file system (NFS). Access to these files can be (and often is) significantly slower, because data packets are routed via the network. However, this directory will be kept after you have given your presentation and received your grade. It should contain a tidied up version of all your data that is worth preserving and was too large to be uploaded to our SVN (see item 1).</p>
}}}

= Coding Standards =

Your code should be properly documented, it should have a consistent style, and there should be unit tests for the non-trivial functions. For the common languages C++, Java, and Python you find examples in out [[https://daphne.informatik.uni-freiburg.de/CodingStandards/svn|Coding Standards]].

In your subfolder in our SVN, there should be a ''README.txt'' or ''README.md'', in which you clearly explain how you organized your files and what can be found where. If as part of your project or theses you generated valuable data (= data, which and only be recreated with large effort or not at all), you should put this data in the folder '''/nfs/students/&lt;username&gt;''' (see above) and mention this in the README as well.