Introduction to ACSE-9 Logistics Imperial College London ACSE-9 Briefing March 12th, 2021 Course coordinator: Dr Adriana Paluszny Types of Projects Academic Placement (Project with a University Supervisor), Industrial Internship (Project with a Company Supervisor), Kaggle (Competitive Project with a University Supervisor) Confirmed Internship/Projects Have you confirmed your project? Have you contacted your supervisors? Do this by April 2nd. Will your internship/project be done remotely? Have you confirmed this with your supervisor? First and Second Supervisor Have you identified them? One of them should be based at Imperial. Backup projects Do you have an internship? If yes, do you also have a backup research project? Everyone should have a backup research project. Confidential projects Will only release the project deliverables to supervisor and designated evaluators. Evaluation / Who will evaluate/mark my work? Survey of Final Project Information I will send a survey shortly before the project starts to gather final information. Dates April 2nd (16:00 UK time) -- Students submit project preferences April 9th -- Preliminary Project allocation announced June 1st – Project/Internship Start June 25th (17:00 UK time) -- Project Plan submission August 27th -- Internship End August 27th (17:00 UK time) -- Final Report submission deadline September -- Project presentations Writing course The writing course will take place at 2:00-3:30 pm on June 14th. You should receive an email about this. Please attend! Objectives of course - On successfully completing this module, students should have: o Contributed to an active research area o Defended research output under critical questioning o Effective communication, writing and presentation skills o Experience of managing their time effectively o Critical analysis techniques and the ability to creatively solve challenging problems o Developed a significant software project Description This module involves each student in the independent analysis of a technical problem for which they will devise, implement, test, modify, validate and document a practical computational solution. A range of such problems will be provided to students who may opt to solve one of these, to solve a problem of their own devising, or to undertake a computational project as part of an external industry placement. Self-devised and external projects will require the agreement of the project leader. Professional computational projects are seldom performed in isolation. Consequently, students may use whatever resources they can discover to assist in their project but must declare their use of such resources in full within a declaration accompanying their final report. Students will submit a technical report in the form of a users’ and a developers’ guide to their software, and that contains the necessary technical background required to understand the initial problem, and the methods used to solve that problem, together with appropriate test and validation results. Finding a project A list of project titles is now available, along with the names and e-mail addresses of the supervisors. A brief description of each of these projects will be provided as soon as possible, thereafter. During the next weeks you should contact supervisors to discuss projects with the aim of deciding which projects you are most interested in undertaking. Students are encouraged to steer their projects through discussions with potential supervisors. You will be asked to select four projects in order of preference; you should submit your preferences by completing this link: https://imperial.eu.qualtrics.com/jfe/form/SV_3WsbMV8yPdzXcGO Allocation of projects to students is overseen by the Project Coordinator who will take account of your indicated preferences. However, please note that allocation is an over-constrained problem: your first preference cannot be guaranteed, since individual supervisors can only take responsibility for a limited number of projects. We will endeavour to allocate everyone with one of their selected projects, but may have to ask for further preferences if that proves impossible. Selecting a project Please read through this section carefully before proceeding. • Everyone should complete the survey. • Everyone should select at least four choices (even if they have a project which is not listed - these will become your backup choices). • Please select different options. • If you have a project or internship which is not part of the list you will be requested to input details (after selecting the three choices). • If you have a project or internship which is not part of the list you will be allocated this as your main preference. • You can apply to maximum 3 internships. • You can apply to maximum 4 research projects. • If you apply for three internships, you will need to select a Research “backup" option. • If you are currently employed, and you plan to apply to an internship, we recommend that you disclose your employment status to the company that is offering the interview, and to inform your current employer that you are applying for the internship. • For those applying to internships, please prepare all your documents to submit to the companies. You will submit your application directly to the company (Remember to write a tailored cover letter for each of your applications). • For those applying to internships, you will receive an email confirming that you have the green light to apply, from March 16th. • For those applying to internships, please inform me, with copy to Ying Ashton and your industrial supervisor(s), when/if you are accepted. • If you are allocated a research project, you will be informed via email (by Ying Ashton or myself). • Projects will be allocated progressively. The allocation process will be merit- based. • Take your time to decide but contact potential supervisors now to enquire about potential projects. First actions - Meet your supervisor / contact them over email - Understand the objectives of your project - Understand the data requirements of your project - Download and setup your technical framework - Schedule regular meetings with supervisors, aim for weekly meetings - Read and prepare yourself (you should aim to have read around 15-20 papers during the project), Take notes, Prepare for your meetings, Log your meetings Deliverables - Project Plan 5% + (Final Report + Code) 75% (Split to be confirmed) - Project Plan o Progress to Date and Meeting Log (10%) o Written Report (Introduction, Literature Review, Description of Problem and Objectives, Progress to Date and Future Plan, References) 70% o Independence and initiative (20%) - Final Report + Code o Abstract / Introduction / Problem Statement / Literature Review (20%) o Software Development Life Cycle / Code metadata / Methodology (30%) o Code / Implementation / Results (30%) o Discussion / Conclusions / Bibliography (20%) - Individual oral presentation and practical demonstration of the software in action 20% Essential Report Guidelines You must provide information that identifies you as the author of the code and report. In the first page of the project plan and report, include the following information: University, Course Name, Module Name, First and Last name, GitHub login, Email, Date, Title of the project, and Supervisors. If you undertook your IRP as an intern in a company, please also add the company name, address, and company supervisor. In the first page, please also add a link to your repository. Example Word templates are provided in students’ GitHub repositories. For the code: Add your name/GitHub login as a comment to each file that you write and upload to the repository (when possible, in the first line). Backup and repository usage: While infrequent, hardware failures do occur, as does user error. You are strongly recommended to keep multiple independent backups of you work under a proper versioning system, and to take full advantage of cloud storage, such as by regularly updating your GitHub repository. In particular, mitigating circumstance claims regarding multiple weeks of lost work are unlikely to be accepted. Project Plan Report - It is a short document (1,500 words). - Should be written in Word or Latex, Single Spaced, with equiv. 11pt Arial font. - Should include: Introduction, Literature Review, Description of Problem and Objectives, Progress to Date and Future Plan, References - The submission should also include your Meeting/Contact Log where you will summarise your interaction with your supervisor. On a single page, add a table with the following entries: Date, Attendees, Type (Email, Voice Call, Video Call, Face-to-Face), Subject. Project Plan Structure Your project plan should be a short summary of the problem you are addressing and your strategy to address it. The project plan is an important part of your project and is not optional. The project plan will be evaluated, it will count for 5% of your total mark. Writing a project plan is a very important first step in an independent research project. Your project plan should be a short summary of the problem you are addressing and your strategy to address it. It should include a short introduction, description of the problem, objectives, progress to date and schedule. You can also add tasks and milestones if appropriate. You should include relevant referencing throughout your document. You should prefer Harvard-style referencing (https://www.imperial.ac.uk/admin-services/library/learning-support/reference- management/harvard-style/). You should make sure to reference sources of value; for example, papers sourced from indexed journals from sites such as ScienceDirect and Scopus. Project plans can be prepared with any editor, including MS Word, Latex, OpenOffice, etc, and should be submitted as PDF files. Project Plans should be written in font size 11pt. Plans should be maximum 1,500 words (shorter reports will not be penalised), the title page and references will not count towards the word limit. While there is no restriction of the font type, when possible, you should prefer a sans-serif font (such as Arial) as recommended by the British Dyslexia Association. Your Project Plan should, in the first page, have the information that identifies you as the author of the code and report. In the title page of the project plan and report, include the following information: University, Course Name, Module Name, First and Last name, GitHub login, Email, Date, Title of the project, and Supervisors. For internships add the company name, address, and supervisor. In the first page, please also add a link to your repository. Example Word templates are provided in students’ GitHub repositories. Please name your file with your name followed by ‘_ACSE9_ProjectPlan’, for example “RickDeckard_ACSE9_ProjectPlan.pdf”. Final Report - It is a document. - Should be structured as a paper. - The project should have a brief literature review, a description of the problem and objectives, methodology, results, and conclusions. You should also explain your implementation, validation, testing, performance. - Two types of focus Research and/or Software. - Should be written in Word or Latex equiv., single spaced, with equiv. 11pt Arial font. - The project report should contain maximum 5,000 words. The reports can be shorter. - The project can have an Appendix with further text and images. - Will be marked by your supervisors and/or an additional marker. - Some of you will have been assigned the same project. Remember that this is an independent project. - These guidelines may be refined and will be posted in the GitHub page. Final Report Structure Prepare your report following the structure of a paper to be submitted to an academic journal. One possible structure for your document is to follow the guidelines for the journal SoftwareX (https://www.journals.elsevier.com/softwarex) or Journal of Open Source Software (https://joss.theoj.org). In the Writing course organised for June 15th you will review the process of writing this type of report. Project plans and reports can be prepared with any editor, including MS Word, Latex, OpenOffice, etc, and should be submitted as PDF files. Appendices containing supplementary information can be submitted along with the final report as separate PDF files; keep in mind that the evaluation will be based on the main submitted report, not the additional documents. Plans and reports should be written in font size 11 pt. The final report should be maximum 5,000 words (shorter reports will not be penalised), excluding the bibliography and appendices. While there is no restriction of the font type, when possible, you should prefer a sans-serif font (such as Arial) as recommended by the British Dyslexia Association. Your report should have the following structure: • Abstract, Introduction (with Motivation and Problem Statement) (20 marks) • Software Description (25 marks) • Code metadata (5 marks) • Implementation & Code (30 marks) • Discussion & Conclusions (15 marks) • Bibliography (5 marks) Abstract: Start with a roughly 200-word abstract, and a maximum of six keywords describing your project and solution (e.g “fluid dynamics”, “machine learning”, “wind turbines”). Your introduction should include a brief summary of the problem that your code/or computational analysis addresses. Describe your objectives and/or hypotheses, and outline the tasks completed during the independent research project. Describe state-of-the-art of solutions to the problem, including commercial and academic approaches, and cite these using the reference style described in the “Guide for Authors” document from the SoftwareX journal. Describe briefly the requirements of your solution (Software Requirement Specification – SRS). Clearly state how your independent research project goes beyond the state-of-the-art and what original work you have done. Software Description (Methodology): Describe the technical back-end of your solution. Describe if it was developed as a standalone code or if it is an extension of a pre-existing piece of code. In the latter case, briefly describe the ecosystem in which you developed your solution. List and describe what development and operation tools (devops) have been used, outline the development methodologies used, and describe why. Add an architectural design diagram of your solution if relevant. Describe your design rationale and your implementation strategy, including the description of main data structures, routines, and any parallelisation paradigm (shared vs. distributed), and their respective verification and validation routines. Add algorithms, pseudo-code, and if required also code snippets of the most important functionality that you implemented. Emphasise the novelty and creativity of your own work. Code metadata: You should succinctly describe the technical platform of your implementation, including any compilation requirements or dependencies – such as programming languages and libraries (open source or proprietary), as well as a description of both the implementation and deployment platforms (operating system, basic hardware requirements if any). Add the current code version number of your software/computational solution, a link to the code (such as a link to the repository), and links to any developer documentation, user and/or developer support documents. This can be a table, or a short paragraph. Implementation & Code Description (Results): Describe the simulation features and capabilities, as well as the test/study cases investigated during your IRP. Describe the unit or system tests, and where applicable also integration tests, that you ran to determine if your program accurately solves the stated problem. Present validation and/or verification results. Describe the implementation of your design, the functionality of your code, and how it may affect accuracy, efficiency and scaling of your computational solution. Present the results of your computational analysis and quantify your results. Discussion & Conclusions: Add a brief discussion session to the report. What were the most difficult tasks to resolve in completing the implementation? What are the strengths and limitations of your solution? What are the next steps? What worked and what did not work? Be formal in your analysis, as if you were writing a journal paper, quantify your statements and base your conclusions on findings of your study. If applicable, briefly describe any planned future work related to your project. Bibliography & Appendices: List all resources (e.g. books, articles, manuals) that you consulted to understand and develop the project should be included and properly cited in the text. You should include relevant referencing throughout your document. You should prefer Harvard-style referencing (https://www.imperial.ac.uk/admin- services/library/learning-support/reference-management/harvard-style/). You should make sure to reference sources of value; for example, papers sourced from indexed journals from sites such as ScienceDirect and Scopus. You may include APPENDICES with the report in separate files but note that these will not be formally assessed. Alternative Structure: This structure is a guideline, and you can of course deviate from it. For example, you can alternatively adopt the clasic Introduction- Methodology-Results-Conclusions format if you find it is better suited to your project (do include your Code Metadata somewhere though!). Examples: Examples of Final Reports of previous years will be uploaded to the folder. Please notice that guidelines will have changed throughout the years (for example, length and title page). CODE Document your uploaded code, and add a readme file that briefly describes all files, how it can be compiled/executed, and what the input/output of your programme is. Your code will be assessed based on the included documentation (including any installation instructions and user guide), test suites and any additional software infrastructure (e.g., issue tracker/wiki), that have been submitted on GitHub. In addition, markers will take into consideration the implementation and assessment of your code, as described in your written report. WORDS How will words be counted? The following will not count towards the word limit: Text in Figures, Tables, Images, Captions, References, Title Page, Appendices. Please do not worry if you are slightly above the word count. Will code count as words? Code snippets, algorithms and pseudo-code embedded in the text will count towards the word limit. Code snippets, algorithms and pseudo- code part of/presented as figures will not count towards the word limit. All figures should be properly acknowledged and referenced in the text. Presentation - Presentation Guidelines will be sent closer to the date. You should prepare to give a 10-15 min presentation of your work. - You should prepare approximately 10 slides. - You will be able to present remotely and may be recorded. You may be asked to submit a recorded presentation. - Your presentation will be evaluated. - You must attend your presentation. - Your supervisor may or not attend your presentation. - You will be asked questions about your work and your findings. Plagiarism Plagiarism is not permitted and is severely penalised by the college. Please refrain of plagiarising/copying text or code. Examples of unsuccessful projects - Student spent the entire summer doing something else, and put together a submission within the last two weeks - Too much time spent classifying data - Code not written by student - Report written in poor English - Not enough code written - Findings are not clear - Analysis is poor - Did not follow instructions and advice from supervisor(s) - Code was not validated - No quantification of results - Did not prepare draft for feedback before final submission Study Groups During the summer, each of the students will be part of a Study Group. These will meet once a week for about 30 min using Teams video chat. During these meetings each student will give a 2-min update of your project (students should prepare what you will say!), then there will a short comment from the moderator. Moderators may be GTAs, or coordinators. The GTAs for this year's course will be in contact with students to schedule these meetings. Additional Notes - Holidays and Absent periods must be notified to your supervisor. If longer than THREE days, you must also notify the coordinator (A Paluszny) - Any Covid related delays or impedances should be reported to the supervisor, coordinator or senior tutor. Note: This document is subject to changes.
欢迎咨询51作业君
