Skip to content

Project marking

Code

You should submit to MOODLE a single zip file or tarball containing all your Python scripts for the PHYS5151 project. The zip file or tarball should also contain a plain text file called README or README.txt that briefly describes the contents of each Python file, and describes how to run your program, e.g., which script to run to reproduce the simulations described in your report. You should not generally include data files in your submission, especially if the files are large.

Some general advice:

  • Back up your code somewhere (e.g., Microsoft OneDrive, Dropbox, Google Drive, GitHub, GitLab or a USB memory stick).

  • As you develop your code, save copies of your Python files as you go along (e.g., in directories with names such as PHYS5151-program-2026-12-03). This will ensure that if you break your program you can go back to an earlier version. Alternatively, if you are familiar with version-control software such as Git, you are welcome to use that instead.

  • You should try to generate results at each stage as you develop your program rather than waiting until everything is complete; this way you ensure that you have results to discuss in your report.

  • Break your program into modules consisting of logically related classes and functions, and place each of these modules in a separate file. Where appropriate, place scripts that do tests or post-simulation analyses in their own files too.

  • For long simulations, output the data to a file (or files) and write plotting programs as separate, standalone scripts that read in the simulation data. You don't want to have to rerun a ten-hour simulation just to change the marker style or font size on a plot!

  • Whilst having a fancy graphical user interface or the ability to make pretty movies of your simulations is nice, do not waste much of your valuable time on these things; testing, gathering and analysing scientific data, and writing your report are much more important.

  • If you're not sure how to create a zip file then please look up how to do this well before the deadline!

  • Please note that it is your responsibility to ensure that the code and report are uploaded to MOODLE correctly. A common cause of problems is the inclusion of large output files (e.g. .npy files) in the code zip file. Simulation results should not generally be included in your code submission and in most cases the code zip file should be very much less than 100 kB in size. Please ensure that you have deleted or moved any output files before creating your code zip file. It is also advisable to check that the zip file has been uploaded correctly by re-downloading it from MOODLE. Another occasional source of difficulties is the inclusion of large figures in the report PDF file.

If you are struggling with where to start, please make use of the two project exercises ("Final Project Part 1" and "Final Project Part 2" on MOODLE) as a starting point for your simulation. Also look at the example test file accompanying the Week 6 exercises on MOODLE. These exercises are intended to help you get started with your project code.