Commit d688bc2f authored by Éamonn Murray's avatar Éamonn Murray

Update general assignment instructions

parent 09e2887f
......@@ -43,9 +43,10 @@ Assignments
- Assignments will be posted on the course blackboard page each week,
typically as a pdf file or jupyter/ipython notebook.
- Where Python code is asked for, these should be created as executable Python
files suffixed as `.py` and conforming to the Python 3 standard, and
beginning with the line `#!/usr/bin/env python3`. You should **not** submit
jupyter notebooks unless specifically requested.
files suffixed as `.py`, conforming to the Python 3 standard. If the code
is intended to be run directly, ensure the script is executable (c.f.
`chmod`) and begins with the line `#!/usr/bin/env python3`.
You should **not** submit jupyter notebooks unless specifically requested.
- Please test your code, and functions individually.
- To allow automatic testing, and importing of functions from modules you
write please ensure:
......@@ -54,13 +55,19 @@ Assignments
[boilerplate](../python1/README.md#boilerplate-modules-and-using-a-main-function).
- Functions do not produce plot or print output *by default* unless
specifically requested.
- If input or output is requested in a certain format, try your best to
follow this request.
- If you are asked to name function, argument, module or code a in a
particular way, please follow this request.
- Python code should follow [the PEP8 style
guide](https://www.python.org/dev/peps/pep-0008/) as much as possible. Your
code should be properly commented. Functions should have docstrings that
outline what the function does, what the arguments it expects are, and what
it returns.
- Any Python code you write should only import modules from the standard
Python library, NumPy, SciPy or MatPlotLib.
- **Wrong documentation is worse than no documentation.** If you modify a
function from one given in the class, be sure you also update the docstring.
- Any Python code you write should only import modules you have written, or
from the standard Python library, NumPy, SciPy or MatPlotLib.
- You will not necessarily have covered everything I will ask you to do in the
courses you have taken so far. Python and the various libraries you are
using in this course are very well documented online. It is important to
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment