This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
submission_guide [2011/10/05 12:10] – scmfcl | submission_guide [2023/03/16 12:11] (current) – [Extremely Large Files/Archives] scmfcl | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | This explains how to submit the deliverables for your final year | + | ====== Submission Guide ====== |
- | project. All deliverables must 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, but other files may be required, as agreed upon in the initial plan. | + | |
- | * [[Final Report]]:: At least one PDF document for the written final report, but usually more files providing additional deliverables are required, as agreed upon in the initial plan. | + | |
- | ====== 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. |
- | PATS enables you to submit nearly all parts of your project online. | + | 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 |
- | Each submission consists of a collection of files under the following | + | |
- | sections: | + | |
- | | + | Submission generally consists of **two** main steps: (i) **upload and check all files** |
- | | + | |
- | | + | |
- | * **Other files**: Here you can upload any other files to support your report. This is provided to enable you to submit any special | + | |
- | Note that, of course, not all file types need to be included | + | After completing step (ii), we suggest downloading and checking the contents |
- | submission. What is suitable often depends | + | |
- | report and please discuss with yout supervisor | + | |
- | submitting if you are unsure. | + | |
- | To add files to these sections, press the related [Upload] link which | + | In a submission on PATS, we usually expect |
- | opens a separate upload dialog. 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 M5 or SHA1 checksum | + | |
- | [[checksums]]). You can further rename, delete | + | |
- | down in the list for each section. You cannot exchange files between | + | |
- | sections. | + | |
- | After you have uploaded at least one document file you can complete | + | ===== File Submission ===== |
- | the submission. This will generate a zip file containing all the files | + | |
- | you've uploaded in all sections, sorted by these sections and in order | + | |
- | they are displayed in the submission area. **Your files count as | + | |
- | submitted only after you have completed the submission**. While files | + | |
- | in the content area are visible to your supervisor and moderator, they | + | |
- | cannot actually approve or mark them. | + | |
- | You can resubmit | + | For each deliverable, |
- | midnight | + | * **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 |
- | previously submitted | + | * **Support |
- | always upload all files into the submission area and then submit them | + | 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 |
- | all at once by completing the submission. | + | |
- | The system will keep the current and the previous submission archive. | + | 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 |
- | You can delete these archives at any time before | + | |
- | download | + | |
- | the archive before completing the submission, select | + | |
- | Submission" | + | |
- | **Make sure you check the contents of any files you upload | + | For the files in the document section, |
- | submission | + | |
- | Files uploaded via the network may sometimes be corrupted and downloading | + | |
- | 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 | + | After you have uploaded at least one file to the document files section, you can complete the submission. This will generate a zip file containing all the files you have uploaded in all sections, sorted by these sections, and in order they are displayed |
- | have in the submission area and your current | + | |
- | archive (unless you delete them). | + | |
- | See the [[PDF Guide]] for information | + | You can resubmit at any time before |
- | ====== Physical Artefacts ====== | + | **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). |
- | Some projects may also produce physical artefacts without any digital | + | ===== Physical Artefacts ===== |
- | versions of them. Hardware or similar physical objects do not need to | + | |
- | 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 documentation necessary for your | + | |
- | 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 | + | Some projects may also produce physical artefacts without any digital versions of them. Hardware |
- | directly included in the report as a figure. For documents larger than | + | |
- | A4 we recommend taking photos of these and submit the image files via | + | |
- | 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 | + | |
- | system models drawn manually. | + | |
- | In addition to the digitised version, | + | 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 |
- | should also be handed in by the submission deadline | + | |
- | office in an envelope. On the envelope clearly write your name, the | + | |
- | title of your project and the names of your supervisor and moderator. | + | |
- | The document | + | |
- | 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 | + | If you have any problems with this, discuss them with your supervisors |
- | documents from Frank Langbein. | + | |
- | 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 for you. | + | |
- | ====== Submission Problems and Peace of Mind ====== | + | ===== Extremely Large Files/ |
- | After you submitted your files on PATS as an archive (not just | + | 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 |
- | uploaded 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 | + | |
- | of your submitted file. However, | + | |
- | integrity of your submission | + | |
- | 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 (similar to the submission archive generated by PATS). | + | You may make larger |
- | * Compute an MD5 checksum of this archive file and store it in a separate file. | + | |
- | * 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 to LangbeinFC@cf.ac.uk | + | |
- | While the procedure is optional it avoids any problems arising from | + | ====== Submission Problems and Peace of Mind ====== |
- | the online submission. If you provide an MD5 checksum, then the | + | |
- | following applies: | + | |
- | * If you have submitted | + | 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 |
- | * If for whatever reason | + | * Put all the files you wish to submit |
+ | * Upload | ||
+ | * 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 | ||
+ | * 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 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. | ||
- | For details on how to generate MD5 checksums, etc. please | + | If, for some reason, you are unable |
+ | * 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 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 the checksum before the deadline would, of course, work). | ||
+ | * 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 ====== | ||
- | 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 | + | * 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 | + |