Skip to content

Commit

Permalink
Updated website
Browse files Browse the repository at this point in the history
  • Loading branch information
borjasotomayor committed May 2, 2024
1 parent 5736947 commit d55e04d
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 79 deletions.
2 changes: 1 addition & 1 deletion projects/project2.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ <h2>Initializing your Project 2 Repository<a class="headerlink" href="#initializ
SSH URL of your repository. To get this URL, log into GitHub and navigate to your
project repository. Then, under “Quick setup — if you’ve done this kind of thing before”,
make sure the “SSH” button is selected, and copy the URL that appears next to it.
It should look something like this: <code class="docutils literal notranslate"><span class="pre">git&#64;github.com:uchicago-cmsc23320-spr-24/chirc-jdoe-jrandom.git</span></code></p>
It should look something like this: <code class="docutils literal notranslate"><span class="pre">git&#64;github.com:uchicago-cmsc23320-spr-24/chitcp-jdoe-jrandom.git</span></code></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>git init
git remote add origin $REPO_URL
git remote add upstream https://github.com/uchicago-cs/chitcp.git
Expand Down
27 changes: 10 additions & 17 deletions projects/project3.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,6 @@

<section id="project-3-chirouter">
<h1>Project 3: chirouter<a class="headerlink" href="#project-3-chirouter" title="Link to this heading"></a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This page has not yet been updated for Spring 2024.</p>
</div>
<p>In this project you will be implementing a simple IP router capable of routing IPv4 datagrams between multiple networks. This router will have a static routing table, so you will not have to deal with implementing a routing protocol like RIP or OSPF; instead, the project will focus on the routing of IP datagrams. While, at a high level, this just involves receiving IP datagrams and figuring out what interface they should be sent on, this requires building additional functionality before you can actually start routing IP datagrams.</p>
<p>Please refer to the following documents to complete this project:</p>
<ul class="simple">
Expand All @@ -111,15 +107,12 @@ <h1>Project 3: chirouter<a class="headerlink" href="#project-3-chirouter" title=
<li><p><a class="reference external" href="project3_tips.html">Project 3 tips</a></p></li>
</ul>
<p>Take into account that this project requires using a network simulator that
needs to be run with root privileges on a Linux machine. If you do not have
access to such a machine, you can use the <a class="reference external" href="https://howto.cs.uchicago.edu/vm:index">CS Virtual Machine</a>
(version 202122.2 or higher) to run the network simulator. This virtual
machine will only work on computers with Intel processors so, if you are running
a newer Mac with an M1 processor, please see our Ed Discussion site for instructions
on how to set up a virtual machine on your computer.</p>
needs to be run with root privileges on a Linux machine. For students using
Windows or Mac, we provide a Docker container that you can use to run
the network simulator on your computer ()</p>
<section id="submission-timeline">
<h2>Submission Timeline<a class="headerlink" href="#submission-timeline" title="Link to this heading"></a></h2>
<p>This project has two required submissions, and an optional resubmission:</p>
<p>This project has one required submission, and an optional resubmission:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Submission</p></th>
Expand All @@ -128,13 +121,13 @@ <h2>Submission Timeline<a class="headerlink" href="#submission-timeline" title="
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Final Submission</p></td>
<tr class="row-even"><td><p>Project 3</p></td>
<td><p><a class="reference external" href="http://chi.cs.uchicago.edu/chirouter/">chirouter</a> (entire project)</p></td>
<td><p><strong>Wednesday, November 30, 8pm</strong></p></td>
<td><p><strong>Wednesday, May 15th, 8pm</strong></p></td>
</tr>
<tr class="row-odd"><td><p>Resubmission (Optional)</p></td>
<td><p>You may submit a revised version to improve your Completeness score <em>only</em></p></td>
<td><p><strong>Friday, December 9th, 8pm</strong></p></td>
<td><p><strong>Friday, May 24th, 8pm</strong></p></td>
</tr>
</tbody>
</table>
Expand All @@ -148,9 +141,9 @@ <h2>Initializing your Project 3 Repository<a class="headerlink" href="#initializ
<p>Only one team member needs to run these commands. Create an empty directory and, inside that
directory run the following commands. In the commands below, <code class="docutils literal notranslate"><span class="pre">$REPO_URL</span></code> refers to the
SSH URL of your repository. To get this URL, log into GitHub and navigate to your
project repository. Then, click on the green “Code” button, and make sure the
“SSH” tab is selected. Your repository URL should look something like this:
<code class="docutils literal notranslate"><span class="pre">git&#64;github.com:uchicago-cmsc23320-2022-aut/chirouter-p3-jdoe-jrandom.git</span></code></p>
project repository. Then, under “Quick setup — if you’ve done this kind of thing before”,
make sure the “SSH” button is selected, and copy the URL that appears next to it.
It should look something like this: <code class="docutils literal notranslate"><span class="pre">git&#64;github.com:uchicago-cmsc23320-spr-24/chirouter-jdoe-jrandom.git</span></code></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>git init
git remote add origin $REPO_URL
git remote add upstream https://github.com/uchicago-cs/chirouter.git
Expand Down
66 changes: 40 additions & 26 deletions projects/project3_rubric.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,10 @@

<section id="project-3-rubric">
<h1>Project 3 Rubric<a class="headerlink" href="#project-3-rubric" title="Link to this heading"></a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This page has not yet been updated for Spring 2024.</p>
</div>
<p>The grading of this project follows a specifications grading approach. If you have not already
done so, make sure to read our <a class="reference external" href="../grading.html">Grading</a> page for more details.</p>
<p>You will receive two ESNU scores for this project:</p>
done so, make sure to read our <a class="reference external" href="../syllabus.html#grading">Grading</a> section of
the syllabus for more details.</p>
<p>You will receive two SNU scores for this project:</p>
<ul class="simple">
<li><p><strong>Completeness score</strong>: This score will be determined solely by the result of running
the automated tests, as these give a measure of how <em>complete</em> your implementation
Expand All @@ -143,7 +140,7 @@ <h1>Project 3 Rubric<a class="headerlink" href="#project-3-rubric" title="Link t
</section>
<section id="submission-timeline">
<h1>Submission Timeline<a class="headerlink" href="#submission-timeline" title="Link to this heading"></a></h1>
<p>This project has one required submission, and an optional resubmission:</p>
<p>The exact timeline of submissions will be the following:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Submission</p></th>
Expand All @@ -152,19 +149,35 @@ <h1>Submission Timeline<a class="headerlink" href="#submission-timeline" title="
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Final Submission</p></td>
<tr class="row-even"><td><p>Project 3</p></td>
<td><p><a class="reference external" href="http://chi.cs.uchicago.edu/chirouter/">chirouter</a> (entire project)</p></td>
<td><p><strong>Wednesday, November 30, 8pm</strong></p></td>
<td><p><strong>Wednesday, May 15th, 8pm</strong></p></td>
</tr>
<tr class="row-odd"><td><p>Resubmission (Optional)</p></td>
<td><p>You may submit a revised version to improve your Completeness score <em>only</em></p></td>
<td><p><strong>Friday, December 9th, 8pm</strong></p></td>
<td><p><strong>Friday, May 24th, 8pm</strong></p></td>
</tr>
</tbody>
</table>
<p>Unlike Projects 1 and 2, the resubmission can only be used to improve your Completeness score
(i.e., the score on the automated tests). Since Project 3 is due by the end of the quarter,
there is not enough to do a full resubmission-regrading cycle.</p>
<p><strong>NOTE</strong>: To make a resubmission, you must make a “good-faith” submission by the project
deadline. A good-faith submission is any submission where it is clear you have put it
a substantial amount of effort to complete the project. Please note that we will consider
any submission that scores an N in completeness to meet the bar for a good-faith submission.</p>
<p>This means that, if you want to make a resubmission, you cannot skip the initial
submission, or submit an effectively empty submission. The reason for this is that
such a submission could score an S in Code Quality purely because most of the rubric
items are moot (because there is little/no code to grade). Your resubmission could
then score an S in Completeness, but then have major Code Quality issues.</p>
<p>In practical terms, this means the following:</p>
<ul class="simple">
<li><p>If you are scoring an N on the tests in your initial submission, you have nothing to
worry about. You can make a resubmission to raise your test score to an S.to</p></li>
<li><p>If you skip the initial submission, or score a U in the tests, we reserve the right
to regrade your code for Code Quality in the resubmission.</p></li>
</ul>
</section>
<section id="completeness">
<h1>Completeness<a class="headerlink" href="#completeness" title="Link to this heading"></a></h1>
Expand All @@ -175,25 +188,28 @@ <h1>Completeness<a class="headerlink" href="#completeness" title="Link to this h
</div>
<p>(see <a class="reference external" href="http://chi.cs.uchicago.edu/chirouter/automated-tests.html">Automated tests</a>
in the chirouter documentation for more details)</p>
<p>Your ESNU score will then be determined as follows:</p>
<p><strong>NOTE</strong>: In Project 3, you will be relying on manual testing to a greater extent
than in Projects 1 and 2. The automated tests provide a convenient way to run all
the tests and get a test score but, in general, if your code works when testing it
manually, and fails the corresponding automated test, you should consider the test
to have passed (you should make a note in the README file so the graders are aware
of this)</p>
<p>Your SNU score will then be determined as follows:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Grade</p></th>
<th class="head"><p>Points on tests</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Excellent</p></td>
<td><p>at least 95</p></td>
<tr class="row-even"><td><p>Satisfactory</p></td>
<td><p>at least 90</p></td>
</tr>
<tr class="row-odd"><td><p>Satisfactory</p></td>
<tr class="row-odd"><td><p>Needs Improvement</p></td>
<td><p>at least 60</p></td>
</tr>
<tr class="row-even"><td><p>Needs Improvement</p></td>
<td><p>at least 20</p></td>
</tr>
<tr class="row-odd"><td><p>Ungradable</p></td>
<td><p>less than 20</p></td>
<tr class="row-even"><td><p>Unsatisfactory</p></td>
<td><p>less than 60</p></td>
</tr>
</tbody>
</table>
Expand All @@ -203,16 +219,14 @@ <h1>Code Quality<a class="headerlink" href="#code-quality" title="Link to this h
<p>When assessing your code quality, there are a number of things we will be paying
close attention to, and which we describe in the sections below (including major
issues, labelled “[Major Issue]” that you should be particularly mindful of).</p>
<p>In general, your ESNU score will be determined as follows:</p>
<p>In general, your SNU score will be determined as follows:</p>
<ul class="simple">
<li><p><strong>Excellent</strong>: Your submission has none of the issues described below or, at most,
has only a few minor mistakes or small style issues that would be trivial to address.</p></li>
<li><p><strong>Satisfactory</strong>: Your submission has a few of the issues described below (but no
major issues), and would only require minor changes to get to an E.</p></li>
major issues).</p></li>
<li><p><strong>Needs Improvement</strong>: Your submission has several of the issues described below,
or at least one major issue. In general, major revisions would be required to
get up to an S or E.</p></li>
<li><p><strong>Ungradable</strong>: Your submission does not constitute a good-faith effort to complete
or at least one major issue. In general, major revisions are typically required to
get up to an S.</p></li>
<li><p><strong>Unsatisfactory</strong>: Your submission does not constitute a good-faith effort to complete
the work. This includes not submitting any work at all, as well as submitting
only placeholder code (e.g., code that includes functions for all the required
IRC commands, but where the functions are empty or filled with “TODO”s, etc.)</p></li>
Expand Down
Loading

0 comments on commit d55e04d

Please sign in to comment.