This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
submission_guide [2011/10/02 17:31] – 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). | + | |
- | See the [[PDF Guide]] for information on how to crate a PDF file. | + | 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. | ||
+ | * **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. | ||
- | ====== Physical Artefacts ====== | + | 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 upload function, which allows you to continue interrupted uploads, but may not work with all browsers and is particularly suitable for larger files. Instead, you can use the standard direct upload, which should work with all browsers, but cannot be resumed. Once you have uploaded a file, you can view its type, file size, and checksums (to check if your upload was successful). You can further rename, delete and move the file up or down in the list in each section. You cannot move files between sections. |
- | Some projects may also produce physical artefacts without any digital | + | 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 completion). |
- | versions of them. Hardware or similar physical objects do not need to | + | |
- | be submitted, but should | + | |
- | examination and your report should contain sufficient information to | + | |
- | rebuild these. Any manually created documentation necessary for your | + | |
- | project should, however, be included in the archive | + | |
- | format. | + | |
- | Anything that fits on an A4 page or smaller | + | After you have uploaded at least one file to the document files section, you can complete |
- | directly included in the report as a figure. For documents larger than | + | |
- | A4 we recommend taking photos of these and including | + | |
- | in the archive. 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 | + | |
- | large soft system models drawn manually. | + | |
- | In addition to the digitised version, the documents larger than A4 | + | You can resubmit at any time before |
- | should also be handed in by the submission deadline to the COMSC | + | |
- | office in an 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 | + | |
- | examination. It will be returned | + | |
- | Assistance is available to create digital versions of such large | + | **Make sure you check the contents of any files you upload in the file submission area and especially the contents |
- | documents from Frank Langbein. If you cannot take any suitable images | + | |
- | of the document, contact him for assistance (to take one or multiple | + | |
- | photos | + | |
- | merge them, please send the images to him by e-mail indicating how | + | |
- | they are spatially related. He will merge these images | + | |
+ | ===== Physical Artefacts ===== | ||
- | ====== Submission Problems and Peace of Mind ====== | + | Some projects may also produce physical artefacts without any digital versions |
- | After you submitted your files on PATS as an archive (not just uploaded | + | Anything that fits on an A4 page or smaller can be scanned and directly included in the report |
- | them into the submission area) your project counts | + | |
- | 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, | + | |
- | and to deal with any problems arising from the server, the Internet | + | |
- | connection or anything else that prevents | + | |
- | in time (i.e. on the day of the submission deadline), please follow | + | |
- | instructions: | + | |
- | * Put all the files you wish to submit into some archive file. | + | If you have any problems with this, discuss them with your supervisors |
- | * Compute an MD5 checksum of this archive file and store it in a separate file. | + | |
- | * Carefully preserve the archive | + | |
- | * E-mail the MD5 checksum to LangbeinFC@cf.ac.uk in an e-mail | + | |
- | While the procedure is optional it avoids any problems arising from the online | + | ===== Extremely Large Files/ |
- | submission. If you provide an MD5 checksum, then the following applies: | + | |
- | * 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 (often this e-mail will arrive earlier, but we cannot | + | We have no strict file size limitations |
- | * If for whatever reason you did not manage | + | |
- | ===== Creating MD5 Checksums ===== | + | You may make larger files/ |
- | An MD5 checksum looks something like this: | + | ====== Submission Problems and Peace of Mind ====== |
- | < | + | |
- | 5be5e4773e92dfb5b2add9b8d562c352 | + | |
- | </ | + | |
- | Please make sure you submit the hexadecimal MD5 sum. In order to | + | |
- | generate such a checksum you may use the following MD5 checksum | + | |
- | generators: | + | |
- | * Linux: md5sum command in shell; | + | |
- | * Mac OS: md5 command in terminal; | + | |
- | * Windows: | + | |
- | * MD5sums, http:// | + | |
- | * FCIV--File Checksum Integrity Verifier http:// | + | |
- | * FastSum, http://www. fastsum.com/ | + | |
- | In exceptional circumstances alternative 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: |
- | as reliable as an MD5 checksum may be acceptable | + | * Put all the files you wish to submit into some archive file (similar to the submission archive generated by PATS). |
- | GNU-PG/ | + | * 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. |
- | if generating an MD5 checksum | + | * 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 | ||
+ | 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. | ||
+ | |||
+ | 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: | ||
+ | * Put all the files you wish to submit into some archive file (similar to the submission archive generated by PATS). Store this somewhere safe so you can produce this file in person or later on via some file-sharing mechanism online from that storage. Ensure the file is not modified (in particular, after you created the checksum). | ||
+ | * Create a checksum | ||
+ | * The project coordinator will then be in touch to arrange to receive the actual file from you and get the data onto PATS. The file must have precisely the checksum you submitted before the deadline, or it cannot be accepted. | ||
+ | So far, we have never had to use this approach. | ||
====== Recommended File Types ====== | ====== Recommended File Types ====== | ||
- | In general we recommend the following file formats, unless there is a | + | 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: |
- | good reason for your project to use a different format: | + | * Documents: Whenever possible, use PDF. Note the main report must be in PDF format |
- | + | * 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. | |
- | * Documents: Whenever possible use PDF. You may include the original document files used to generate the PDF. Note, the main report | + | * 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/ |
- | * Sources: Sources, interpreted files, HTML files, etc. should usually be plain text files encoded in ASCII, UTF-8 or ISO 8859-1 | + | * Images: The JPEG or PNG formats are preferred for compatibility. An image quality of 90% is usually sufficient for JPEG. |
- | * 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 |
- | * Video: Use QuickTime, MPEG or DivX formats. The H.264 and MJPEG codecs are preferred, for compatibility and quality. Usually the | + | * Audio: Use OGG or MP3 for lossy compression or FLAC for lossless compression. For MP3, a sampling rate of 32kbps |
- | * Audio: Use OGG or MP3 for lossy compression or FLAC for lossless compression. For MP3 a sampling rate of 32 kbps is sufficient for voice and analog | + | |
- | + |