This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
submission_guide [2011/10/02 17:28] – created scmfcl | submission_guide [2023/03/16 12:11] (current) – [Extremely Large Files/Archives] scmfcl | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | This is to describe how to submit any deliverables for your final | + | ====== Submission Guide ====== |
- | year project. All deliverables have to be submitted via PATS, except | + | |
- | for physical artefacts (for details see below). For details on what | + | |
- | needs to be included, please see the following topics: | + | |
- | * [[Initial Plan]]: Usually a single PDF file containing the tile, project description, | + | |
- | * [[Interim Report]]: At least one PDF document for the written interim report about the deliverables, | + | |
- | * [[Final Report]]:: At least one PDF document for the written final report about your project findings, etc., but usually more files providing additional deliverables, | + | |
- | ====== Online Submission ====== | + | This explains how to submit the deliverables for your final year project. For what to submit, check the relevant deliverable section for your project module. |
- | The PATS online submission system allows you to submit a range of different | + | All deliverables must be submitted via PATS, except |
- | files for each submission. Note that, of course, not all file types need to | + | |
- | be included for each submission. Each submission consists of a collection of | + | |
- | files under the following sections: | + | |
- | * **Document files**: These must be PDF files and each submission must have at least one of these files - this section for the normal written report. | + | |
- | * **Appendix files**: These are additional | + | |
- | * **Archive files**: These are file archives to provide the sources | + | |
- | * **Other files**: Here you can upload any other files to support your submission. This is provided to enable you to submit any special files for your project in special formats, etc. as an alternative to submitting these in an archive. | + | |
- | To add files to these sections, press the related [Upload] link which opens a separate | + | Submission generally consists of **two** main steps: (i) **upload and check all files** for the submission; (ii) **complete submission** by clicking the " |
- | upload dialog. You can select more than one file at once to upload into a section. | + | |
- | Once you have uploaded a file you can view its type, file size, MD5 and SHA1 checksum | + | |
- | via the provided link. You can use the M5 or SHA1 checksum | + | |
- | the file (also see MD5 checksums below). You can further rename, delete and move the | + | |
- | file up or down in the list for each section. You cannot exchange | + | |
- | After you have uploaded at least one document file you can complete | + | After completing step (ii), we suggest downloading and checking |
- | will generate a zip file containing all the files you've uploaded | + | |
- | by these sections. Only after you have done this, your files count as submitted. You can | + | |
- | resubmit at any time before | + | |
- | day shown). | + | |
- | A resubmission will completely replace the previously submitted files and not | + | In a submission on PATS, we usually expect a report with sufficient evidence to back up your claims such that they can be verified |
- | extend | + | |
- | keep the current and the previous submission. You can delete these archives at any time | + | |
- | before the deadline and also download the archives | + | |
- | to check the archive before submission, select the " | + | |
- | Your supervisor and moderator will be able to see any of the files you have in the | + | ===== File Submission ===== |
- | submission area and your current and previous submission archive (unless you delete them). | + | |
- | ====== Physical Artefacts ====== | + | For each deliverable, |
+ | * **Document files**: These must be PDF files, and each submission must have at least one of these files - this section is for the written report, including any appendices. See the **[[PDF Guide]]** for information on creating PDF files. | ||
+ | * **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) containing code, data or computational/ | ||
+ | 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 area and your current and previous submission archive. | ||
- | Some projects may also produce physical artefacts without any digital | + | To add files to these sections, press one of the related upload buttons, which opens a separate file selection dialogue. You have a choice |
- | versions | + | |
- | be submitted, but should be available | + | |
- | examination and your report | + | |
- | rebuild these. Any manually created documentation necessary for your | + | |
- | project should, however, be included | + | |
- | format. | + | |
- | Anything that fits on an A4 page or smaller can be scanned and | + | For the files in the document section, |
- | directly included in the report as a figure. | + | |
- | A4 we recommend taking photos of these and including | + | |
- | in the archive. If a single photo is insufficient due to resolution | + | |
- | limitations | + | |
- | and combine | + | |
- | large soft system models drawn manually. | + | |
- | In addition | + | After you have uploaded at least one file to the document files section, you can complete |
- | should also be handed in by the submission | + | |
- | office | + | |
- | 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 | + | You can resubmit at any time before |
- | documents from Frank Langbein. If you cannot take any suitable images | + | |
- | of the document, contact him for assistance | + | |
- | photos and merge them, etc.). If you can take the images, but cannot | + | |
- | merge them, please send the images to him by e-mail indicating how | + | |
- | they are spatially related. He will merge these images for you. | + | |
+ | **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 information. (Some PDF files and archives are modified for compatibility and so the checksums are not the same as your local files). | ||
- | ====== Submission Problems and Peace of Mind ====== | + | ===== Physical Artefacts |
- | After you submitted your files on PATS as an archive (not just uploaded | + | 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 |
- | them into the submission area) your project counts as submitted and | + | |
- | you do not have to do anything else. We do not expect any problems | + | |
- | with the network connection, the server | + | |
- | file. However, | + | |
- | and to deal with any problems arising from the server, the Internet | + | |
- | connection or anything else that 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. | + | Anything that fits on an A4 page or smaller can be scanned |
- | * Compute | + | |
- | * Carefully preserve the archive you have submitted or intend to submit in its original form and the MD5 checksum file. For this you may for instance burn it on a CD or DVD. | + | |
- | * E-mail the MD5 checksum | + | |
- | While the procedure is optional it avoids any problems arising from the online | + | If you have any problems with this, discuss them with your supervisors and potentially with our IT Service Desk. |
- | submission. | + | |
- | * If you have submitted your project online, then you will receive an e-mail after the submission deadline with the MD5 checksum of the archive | + | ===== Extremely Large Files/ |
- | * If for whatever reason you did not manage to submit the project online by the deadline, the MD5 checksum (submitted before the deadline) can be used to verify that the archive has been generated | + | |
+ | 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 | ||
+ | |||
+ | You may make larger files/ | ||
+ | |||
+ | ====== Submission Problems and Peace of Mind ====== | ||
- | ===== Creating MD5 Checksums ===== | + | After you complete the submission of your files on PATS, your deliverable counts as submitted, and you do not have to do anything else. You can verify your submission yourself by checking the provided submission archive. 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, Internet connections or anything else that prevents you from submitting the project in time, please follow these instructions: |
+ | * Put all the files you wish to submit into some archive file (similar to the submission archive generated by PATS). | ||
+ | * 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 of this file yourself on the file-sharing site. | ||
+ | * 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 the file before the deadline, you can later share this with your supervisor, moderator and project coordinator if there is a problem with your submission. | ||
+ | * If, for some reason, you cannot upload your files onto PATS, you can also share this file immediately (before the deadline) with the project coordinator, | ||
+ | Generally, sharing files with the project coordinator before the deadline works well to resolve any issues. But note that it may take some time until we can get back to you to sort out the problem. | ||
- | An MD5 checksum looks something like this: | + | If, for some reason, you are unable to submit your files online anywhere, there is a further offline alternative to this process as a last resort: |
- | < | + | |
- | | + | * Create a checksum of this file (see **[[Checksums]]**) and send this checksum to your supervisor, moderator or project coordinator. It must arrive before the deadline. It can be sent by e-mail or given in person with your full name and student id. You can also give this to someone at the COMSC office. Tell them to forward this to the project coordinator. Note that it may be hard to reach anyone in person, so this does not work as a last-minute option (e-mailing |
- | </ | + | |
- | Please make sure you submit the hexadecimal MD5 sum. In order to | + | So far, we have never had to use this approach. |
- | generate such a checksum | + | |
- | generators: | + | |
- | * Linux: md5sum command in shell; | + | |
- | | + | |
- | | + | |
- | | + | |
- | | + | |
- | * FastSum, http://www. fastsum.com/ | + | |
- | In exceptional circumstances alternative checksums that are at least | + | ====== Recommended File Types ====== |
- | as reliable as an MD5 checksum may be acceptable (e.g. SHA1 or | + | |
- | GNU-PG/PGP file signatures). But please contact Frank Langbein early | + | |
- | if generating an MD5 checksum is a problem for you. | + | |
+ | You can use any file type as long as they are suitable in the support file section. However, in general, we recommend the following file formats unless there is a good reason for your project to use a different format: | ||
+ | * Documents: Whenever possible, use PDF. Note the main report must be in PDF format in the document files section. | ||
+ | * 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. | ||
+ | * 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. | ||
+ | * Video: Use MP4, MKV or WEBM container formats. The H.264/AVC and AV1 codecs are preferred for compatibility and quality. Usually the resolution does not have to be greater than 1080p (1920x1080); | ||
+ | * 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 tape recordings, 128 to 192kbps should be used for CD quality and 192 to 320kbps should be used for complex audio sources (containing a broad spectrum of frequencies). For OGG, a quality 0 is sufficient for voice, quality 6 should give you roughly good CD quality, and higher qualities (up to 10) should be used for complex audio sources only. |