-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Web update by igb180 on Mon Dec 4 11:40:16 EST 2023
- Loading branch information
Showing
5 changed files
with
250 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,243 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <!-- Required meta tags --> | ||
| <meta charset="utf-8" /> | ||
| <meta | ||
| name="viewport" | ||
| content="width=device-width, initial-scale=1, shrink-to-fit=no" | ||
| /> | ||
| <meta | ||
| name="description" | ||
| content=" - Harvard University, Institute for Applied Computational Science. Milestone 5" | ||
| /> | ||
| <meta name="author" content="" /> | ||
| <meta | ||
| name="keywords" | ||
| content="" | ||
| /> | ||
|
|
||
| <!-- Bootstrap CSS --> | ||
| <link | ||
| rel="stylesheet" | ||
| href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/css/bootstrap.min.css" | ||
| integrity="sha384-WskhaSGFgHYWDcbwN70/dfYBj47jz9qbsMId/iRN3ewGhXQFZCSftd1LZCfmhktB" | ||
| crossorigin="anonymous" | ||
| /> | ||
|
|
||
| <link | ||
| rel="stylesheet" | ||
| href="https://use.fontawesome.com/releases/v5.2.0/css/all.css" | ||
| integrity="sha384-hWVjflwFxL6sNzntih27bfxkr27PmbbK/iSvJ+a4+0owXq79v+lsFkW54bOGbiDQ" | ||
| crossorigin="anonymous" | ||
| /> | ||
|
|
||
| <link | ||
| href="https://fonts.googleapis.com/css?family=Roboto+Condensed|Roboto:300,400,700" | ||
| rel="stylesheet" | ||
| /> | ||
|
|
||
| <link | ||
| href="https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css" | ||
| /> | ||
|
|
||
| <link | ||
| rel="stylesheet" | ||
| href="../../style/tipuesearch/tipuesearch.css" | ||
| /> | ||
|
|
||
| <link | ||
| rel="shortcut icon" | ||
| type="image/x-icon" | ||
| href="../../style/images/favicon.ico" | ||
| /> | ||
|
|
||
| <link | ||
| rel="stylesheet" | ||
| href="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.css" | ||
| crossorigin="anonymous" | ||
| /> | ||
|
|
||
| <link rel="stylesheet" href="../../style/css/iacs.css" /> | ||
|
|
||
| <title>Harvard CS107 / AC207 | Milestone 5</title> | ||
|
|
||
| <style> | ||
| .navbar { | ||
| background-color: #EFEFEF | ||
| } | ||
|
|
||
| .katex { | ||
| font: normal 1.21em KaTeX_Math, Times New Roman, serif !important; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body> | ||
| <nav class="navbar navbar-dark navbar-expand-md"> | ||
| <div class="container"> | ||
| <a class="navbar-brand" href="../.."> | ||
| <img | ||
| class="navbar-brand-logo" | ||
| src="../../style/images/logo.png" | ||
| /> | ||
| <h3 class="course-title">CS107 / AC207</h3> | ||
| </a> | ||
| <button | ||
| class="navbar-toggler" | ||
| type="button" | ||
| data-toggle="collapse" | ||
| data-target="#navbarsDefault" | ||
| aria-controls="navbarsDefault" | ||
| aria-expanded="false" | ||
| aria-label="Toggle navigation" | ||
| > | ||
| <span class="navbar-toggler-icon"></span> | ||
| </button> | ||
|
|
||
| <div class="collapse navbar-collapse" id="navbarsDefault"> | ||
| <ul class="navbar-nav ml-auto"> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="../../pages/syllabus.html">Syllabus</a> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="../../pages/schedule_static.html">Schedule</a> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="../../pages/project.html">Project</a> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="../../pages/tutorials.html">Tutorials</a> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="../../pages/resources.html">Resources</a> | ||
| </li> | ||
| <form | ||
| class="form-inline my-2" | ||
| action="../../search.html" | ||
| onsubmit="return validateForm(this.elements['q'].value);" | ||
| > | ||
| <div class="input-group input-group-sm"> | ||
| <input | ||
| class="form-control" | ||
| type="text" | ||
| name="q" | ||
| placeholder="Search Topic" | ||
| /> | ||
| <div class="input-group-append"> | ||
| <button class="btn btn-default" type="submit"> | ||
| <i class="fas fa-search"></i> | ||
| </button> | ||
| </div> | ||
| </div> | ||
| </form> | ||
| </ul> | ||
| </div> | ||
| <!-- .collapse navbar-collapse --> | ||
| </div> | ||
| <!-- .container --> | ||
| </nav> | ||
| <main id="content" class="container"> | ||
| <h1>Milestone 5</h1> | ||
| <br /> | ||
| <blockquote> | ||
| <p><strong>Tuesday, December 11th, 09:59 PM</strong></p> | ||
| </blockquote> | ||
| <p>With the development in full swing, this milestone aims to check the integration of a few modules.</p> | ||
| <h3>API tunning</h3> | ||
| <p>As you develop the project, you learn more about the structure, the modules, and so on. The initial API might not be the best, and you might want to change it. You can leave your API draft untouched, as long as it complies with the contract conditions. For the rest of this document, it the latest version of your API will be referred as <code>modified</code>.</p> | ||
| <h3>Features and Integration</h3> | ||
| <p>Developing individual features is straightforward. Integrating them into a cohesive piece of code is the challenge. | ||
| For this item, develop features of different modules, and perform integration tests on github actions. | ||
| You can merge into <code>dev</code> when the feature pass your tests, but <em>Do not delete the branches used to develop new features until the teaching staff review them.</em> | ||
| Remember to commit frequently. Tests should be <em>commited and pushed</em> before any code is written.</p> | ||
| <ul> | ||
| <li>Write the integration tests according to your <code>modified</code> API.</li> | ||
| <li>Implement at least two consecutive modules, including the unit tests, code and documentation. If you have already written the modules, you still have to push the tests first.</li> | ||
| <li>The integration of two modules is correct when all the integration tests pass.</li> | ||
| </ul> | ||
| <p><code>Note</code>: You <em>should</em> commit multiple times to your local repository and clean the local history if needed. Push only when you pass the unit tests.</p> | ||
| <h2>Steps to complete</h2> | ||
| <ol> | ||
| <li>In the <code>main</code> branch and within your <code>docs</code> sub-directory, create a file called <code>milestone4</code>. The type of file is up to you and your group. Two acceptable choices are markdown (<code>milestone4.md</code>) or a Jupyter notebook (<code>milestone4.ipynb</code>).</li> | ||
| <li>Your <code>milestone4</code> document submission should be in the following format:</li> | ||
| </ol> | ||
| <div class="highlight"><pre><span></span><code>teamXX/ | ||
| ├── docs | ||
| │ └── milestone4 | ||
| ├── LICENSE | ||
| ├── README.md | ||
| └── ... | ||
| </code></pre></div> | ||
|
|
||
| <ol> | ||
| <li>Describe the software organization and licencing in <code>milestone4</code>.</li> | ||
| <li>Create branch <code>dev</code>.</li> | ||
| <li>Create the branch <code>featurename</code> to implement your module. Replace "featurename" with the name of the module you want to implement.</li> | ||
| <li>In that branch, write the tests for the module you want to implement. <em>You should commit them before the writing/pushing any other code</em>.</li> | ||
| <li>Write the code for the module you wrote the tests for.</li> | ||
| <li>Every test for the modules should pass.</li> | ||
| <li>The code coverage must be at least 90%.</li> | ||
| <li>Merge the branch into <code>dev</code>.</li> | ||
| <li>(Optional) You can implement another feature, following steps 5-10. You are encouraged to develop the main modules as soon as possible, to focus on the integration later on.</li> | ||
| </ol> | ||
| <h2>Final Deliverables</h2> | ||
| <ol> | ||
| <li>The <code>docs/</code> directory should include a document called <code>milestone4</code> (the | ||
| extension is up to you, but <code>.md</code> or <code>.ipynb</code> are recommended.</li> | ||
| <li>Proper licensing of your project.</li> | ||
| <li>Tests and implementation for your module(s).</li> | ||
| </ol> | ||
| <h2>Grading breakdown</h2> | ||
| <blockquote> | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th><strong>Points</strong></th> | ||
| <th><strong>Task</strong></th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>4</td> | ||
| <td>Software Organization</td> | ||
| </tr> | ||
| <tr> | ||
| <td>4</td> | ||
| <td>License</td> | ||
| </tr> | ||
| <tr> | ||
| <td>15</td> | ||
| <td>Implementation</td> | ||
| </tr> | ||
| <tr> | ||
| <td>15</td> | ||
| <td>(optional) Additional implementation</td> | ||
| </tr> | ||
| <tr> | ||
| <td>23(38)</td> | ||
| <td><strong>Total</strong></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </blockquote> </main> | ||
|
|
||
| <footer class="footer"> | ||
| <div class="container"> | ||
| <span class="text-muted">Copyright 2022 © | ||
| <a class="text-muted" href="https://iacs.seas.harvard.edu/">Institute for Applied Computational Science</a> | ||
| </span> | ||
| </div> | ||
| </footer> <!-- jQuery first, then Popper.js, then Bootstrap JS --> | ||
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script> | ||
| <script | ||
| src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" | ||
| integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" | ||
| crossorigin="anonymous" | ||
| ></script> | ||
| <script | ||
| src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/js/bootstrap.min.js" | ||
| integrity="sha384-smHYKdLADwkXOn1EmN1qk/HfnUcbVRZyYmZ4qpPea6sjB/pTJ0euyQp0Mk8ck+5T" | ||
| crossorigin="anonymous" | ||
| ></script> | ||
| </body> | ||
| </html> |
Large diffs are not rendered by default.
Oops, something went wrong.