This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
submission_guide [2011/11/14 12:29] – scmfcl | submission_guide [2023/03/16 12:11] (current) – [Extremely Large Files/Archives] scmfcl | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Submission Guide ====== | ====== Submission Guide ====== | ||
- | This explains how to submit the deliverables for your final year | + | This explains how to submit the deliverables for your final year project. For what to submit, check the relevant deliverable section for your project |
- | project. | + | |
- | physical artefacts ([[Submission Guide# | + | |
- | For details on what needs to be included, please see the following topics: | + | |
- | * [[Initial Plan]]: Usually a single PDF file containing the tile, project | + | |
- | * [[Interim Report]]: At least one PDF document for the written interim report, but other files may be required, to cover the interim report deliverables as agreed upon in the initial plan. | + | |
- | * [[Final Report]]:: At least one PDF document for the written final report, but usually more files are required, to cover the deliverables as agreed upon in the initial plan. | + | |
- | ====== Online Submission ====== | + | All deliverables must be submitted via PATS, except for physical artefacts. Some larger datasets, videos or similar that are only for general support or context may be provided elsewhere. All submissions must contain at least one PDF file in the document files section, or PATS will not allow you to complete the submission. |
- | PATS enables | + | Submission generally consists of **two** main steps: (i) **upload and check all files** for the submission; (ii) **complete submission** by clicking the " |
- | Each submission | + | |
- | sections: | + | |
- | * **Document files**: These must be PDF files and each submission | + | After completing step (ii), we suggest downloading |
- | * **Appendix files**: These are additional | + | |
- | * **Archive files**: These are file archives | + | |
- | * **Other | + | |
- | Note that, of course, not all file types need to be included with each | + | In a submission on PATS, we usually expect a report with sufficient evidence to back up your claims such that they can be verified and reproduced in principle. Often the report with sources is adequate for this. Sometimes you may have some extra data files, videos or images for demonstrations. You only have to submit files you created yourself. No need to submit any files automatically created, such as compiled object files or binaries. There is also no need to submit files from a framework or development suite or otherwise obtained assets you are using (these can easily |
- | submission. What is suitable depends on your project | + | |
- | report and please discuss with your supervisor | + | |
- | submitting if you are unsure. | + | |
- | To add files to these sections, press the related [Upload] link which | + | ===== File Submission ===== |
- | opens a separate upload dialoe. You can select more than one file at | + | |
- | once to upload into a section in that dialog before you press the | + | |
- | " | + | |
- | file size, MD5 and SHA1 checksum via the provided link. You can use | + | |
- | the MD5 or SHA1 checksum to verify the integrity of the file (also see | + | |
- | [[checksums]]). You can further rename, delete and move the file up or | + | |
- | down in the list in each section. You cannot move files between | + | |
- | sections. | + | |
- | After you have uploaded | + | For each deliverable, |
- | the submission. This will generate a zip file containing | + | * **Document files**: These must be PDF files, and each submission must have at least one of these files - this section |
- | you have uploaded in all sections, sorted by these sections and in order | + | * **Support files**: These are any additional files you wish to submit for your project. They are not part of the main report but form supplementary material or extended appendices. Often these are archives (we try to convert some of them to zip files for compatibility) |
- | they are displayed | + | What is suitable to submit often depends on your project and your report. Please discuss with your supervisor what you should include if you are unsure. Your supervisor and moderator can see any of the files you have in the submission |
- | submitted only after you have completed the submission**. While files | + | |
- | in the content | + | |
- | cannot actually approve or mark them. | + | |
- | You can resubmit at any time before the deadline (all deadlines are by | + | To add files to these sections, press one of the related upload buttons, which opens a separate file selection dialogue. You have a choice to use the resumable |
- | 23:00 on the day shown). A resubmission will completely replace the | + | |
- | previously submitted | + | |
- | always | + | |
- | all at once by completing | + | |
- | The system will keep the current and the previous submission archive. | + | For the files in the document section, you can check if there could be potential issues with the PDF files. You can also combine all files in this section into a single file (PATS will do this automatically upon submission |
- | You can delete these archives at any time before the deadline and also | + | |
- | download the archives to verify their contents. If you wish to check | + | |
- | the archive before completing the submission, select the " | + | |
- | Submission" | + | |
- | **Make sure you check the contents of any files you upload in the file | + | After you have uploaded at least one file to the document |
- | submission | + | |
- | Files uploaded via the network may sometimes | + | |
- | them again to verify their content avoids any problems. To verify they | + | |
- | files you may also use the MD5 or SHA1 [[checksums]].** | + | |
- | Your supervisor and moderator will be able to see any of the files you | + | You can resubmit at any time before |
- | have in the submission area and your current and previous | + | |
- | archive (unless you delete | + | |
- | See the [[PDF Guide]] for information | + | **Make sure you check the contents of any files you upload in the file submission area and especially the contents of the final submission archive. Files uploaded via the network may sometimes be corrupted, and downloading them again to verify their content avoids any problems. To verify the files, you may also use the checksums.** See **[[Checksums]]** for further |
- | ====== Physical Artefacts | + | ===== Physical Artefacts ===== |
- | Some projects may also produce physical artefacts without any digital | + | Some projects may also produce physical artefacts without any digital versions of them. Hardware or similar physical objects need not be submitted but should be suitably demonstrated via videos, images or similar material showing their function. Your report should contain sufficient information to rebuild these. Any physical |
- | versions of them. Hardware or similar physical objects | + | |
- | be submitted, but should be available for demonstration at the oral | + | |
- | examination and your report should contain sufficient information to | + | |
- | rebuild these. Any manually created | + | |
- | project should, however, be included in the archive in a digitised | + | |
- | format. | + | |
- | Anything that fits on an A4 page or smaller can be scanned and | + | Anything that fits on an A4 page or smaller can be scanned and directly included in the report as a figure. For documents larger than A4, we recommend taking photos and submitting |
- | directly included in the report as a figure. For documents larger than | + | |
- | A4 we recommend taking photos | + | |
- | PATS. If a single photo is insufficient due to resolution limitations | + | |
- | you can take multiple overlapping photos of the document and combine | + | |
- | these into a single image. This applies in particular to large soft | + | |
- | system models drawn manually. | + | |
- | In addition to the digitised version, the documents larger than A4 | + | If you have any problems with this, discuss them with your supervisors |
- | should also be handed in by the submission deadline to the COMSC | + | |
- | office in a suitable envelope. On the envelope clearly write your name, the | + | |
- | title of your project | + | |
- | The document will not be archived, but used by your supervisor and | + | |
- | moderator to decide your mark and will be available at the oral | + | |
- | examination. It will be returned to you after the oral examination. | + | |
- | Assistance is available to create digital versions of such large | + | ===== Extremely Large Files/ |
- | documents from Frank Langbein and also the computer support officers. | + | |
- | If you cannot take any suitable | + | We have no strict file size limitations for the submissions. But some projects may produce or use massive data sets (say >50GB) that are unsuitable for submission on PATS for various reasons. We recommend discussing with your supervisor what to do with these and if they are needed. Often it may be more suitable |
- | for assistance (to take one or multiple photos | + | |
+ | You may make larger files/ | ||
====== Submission Problems and Peace of Mind ====== | ====== Submission Problems and Peace of Mind ====== | ||
- | After you submitted | + | After you complete the submission of your files on PATS, your deliverable |
- | uploaded them into the submission area) your project report or plan counts as | + | |
- | submitted and you do not have to do anything else. We do not expect | + | |
- | any problems with the network connection, the server or the integrity | + | |
- | of your submitted file. However, to avoid any problems with the | + | |
- | integrity of your submission and to deal with any problems arising | + | |
- | from the server, | + | |
- | prevents you from submitting the project in time (i.e. on the day of | + | |
- | the submission deadline), please follow these instructions: | + | |
* Put all the files you wish to submit into some archive file (similar to the submission archive generated by PATS). | * Put all the files you wish to submit into some archive file (similar to the submission archive generated by PATS). | ||
- | * Compute an MD5 checksum | + | * Upload the archive on a private online file share, such as your onedrive linked to your university account (this is the best option, if possible), google drive, dropbox, etc. It is important that you cannot change the timestamp |
- | * Carefully preserve | + | * Keep this file unmodified with a verifiable timestamp on the site (at least until you get your mark returned). As the timestamp can serve as a verification that you created |
- | * Send the MD5 checksum to LangbeinFC@cf.ac.uk in an e-mail with the title "Final Year Project MD5 Checksum" | + | * If, for some reason, you cannot upload your files onto PATS, you can also share this file immediately (before |
+ | Generally, sharing files with the project coordinator | ||
- | While the procedure is optional it avoids any problems arising from | + | If, for some reason, |
- | the online submission. | + | * Put all the files you wish to submit into some archive file (similar to the submission archive |
- | following applies: | + | * Create a checksum |
- | + | * The project coordinator | |
- | * If you have submitted your project online, we will contact you by e-mail in case the MD5 checksum | + | So far, we have never had to use this approach. |
- | * If for whatever reason you did not manage to submit the project online by the deadline, the MD5 checksum (submitted before deadline) can be used to verify that the archive has been generated | + | |
- | + | ||
- | For details on how to generate MD5 checksums, etc. please see [[checksums]] | + | |
====== Recommended File Types ====== | ====== Recommended File Types ====== | ||
- | You are free to use any file types as long as they are suitable | + | You can use any file type as long as they are suitable |
- | the submission | + | * Documents: Whenever possible, use PDF. Note the main report must be in PDF format |
- | file formats, unless there is a good reason for your project to use a | + | * Sources: Sources, interpreted files, HTML files, etc., should usually be plain text files encoded in ASCII, UTF-8 or ISO 8859-1 (latin1). Other standard text encodings may be used if necessary. |
- | different format: | + | * Jupyter, matlab, etc. notebooks: consider if these are really suitable for the purpose (e.g. PDF files generated from them may be more suitable for showing analysis results) and make sure you submit them completely, including any separate data needed. They may not be viewable by your markers in any case, so are best treated as optional files for completeness/ |
- | + | * Images: The JPEG or PNG formats are preferred for compatibility. An image quality of 90% is usually sufficient for JPEG. | |
- | * Documents: Whenever possible use PDF. You may include the original document files used to generate the PDF in the " | + | * Video: Use MP4, MKV or WEBM container |
- | * Sources: Sources, interpreted files, HTML files, etc. should usually be plain text files encoded in ASCII, UTF-8 or ISO 8859-1 (latin1). Other standard text encodings may be used, if necessary. | + | * Audio: Use OGG or MP3 for lossy compression or FLAC for lossless compression. For MP3, a sampling rate of 32kbps is sufficient for voice and analogue |
- | * Images: The JPEG or PNG formats are preferred, for compatibility. An image quality of 90% is usually sufficient for JPEG. | + | |
- | * Video: Use QuickTime, MPEG or DivX formats. The H.264 and MJPEG codecs are preferred, for compatibility and quality. Usually the resolution does not have to be greater than 720p (1280x720 pixels). | + | |
- | * Audio: Use OGG or MP3 for lossy compression or FLAC for lossless compression. For MP3 a sampling rate of 32kbps is sufficient for voice and analog | + |