Introduction: laboratory assignments

GitHub introduction

• GitHub Links to an external site. is a provider of Internet hosting Links to an external site. for software development Links to an external site. and version control Links to an external site. using Git Links to an external site..
• We use GitHub to host the open source code developed in the course. This way your code will be developed under a version control system, and you will have access to all the code developed in the course, also after the end of course. 
• Source code here refers to the lab reports 1-4 (.ipynb files).
• To get collaborator status for the course repository, please complete the "submit your GitHub username" assignment. 
• Lab report workflow: (i) create a feature branch, (ii) modify the template file to solve the lab assignments, (iii) open a pull request to add your code to the main branch of the repository.  
• To learn how to create a feature branch and to open a pull request, see GitHub - Create a pull request Links to an external site. or the tutorial GitHub Hello World Links to an external site.. 

Lab report

• Use the structure of the template lab report: Abstract - Introduction - Methods - Results - Discussion. 
• Abstract: short summary of the report including main findings.
• Introduction: framing and statement of the research question (lab assignment) to be investigated.  
• Methods: description of the experiments (domain, mesh, boundary conditions, approximation spaces, equations) to be performed. 
• Results: description of the results from the experiments (output quantities, plots, images, movies). 
• Discussion: analysis of the results in relation to the research question (lab assignment). 
• With regards to the FEniCS code, you do not have to describe in detail what each function does. You can assume that the reader is familiar with the general theory of FEM. Write the report for your fellow students in the course, with such a level of detail that they are able to understand your work and are able to reproduce it.  
• Template lab report is available at GitHub as: "template-report-lab-X.ipynb"
• Make a reference to any results used from the lecture notes (e.g. Theorem X, Chapter Y), and make a reference (e.g. a hyperlink) to any external sources used.
• Please use images or movies to illustrate your results, but only if they are referred to in the text.
• Individual reports should be submitted. Collaboration is encouraged, but should be acknowledged in the report. 
• GitHub branch name convention (use a separate branch for each lab): "username_labX"
• GitHub filename convention: "LabX/username_labX"

Submission 

1. Upload to Canvas your report in the form of a Jupyter Python 3 notebook (.ipynb), which has been tested and verified in Google Colab before submission. 
2. Submit a pull request to the master branch of the course repository at GitHub.