Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 2.61 KB

project-instructions.md

File metadata and controls

29 lines (20 loc) · 2.61 KB
Raw

Submission of final project

The final assignment of the course consists in a small Python project, ideally something that could be useful for your work or some extra-curricular endeavior. If you have already some half-backed or questionably written project going on, expanding and refactoring would also be suitable ideas!

While you work on the project, feel free to ask for feedback at any point!

Format

The project should be uploaded to a public repository in your GitHub, named python-cimec-name-surname. A link to the repository will be the only accepted submission form! (There will be a class about publishing code on GitHub). If you have concerns about leaving it open, let us know and we can discuss it.

Project content

Depending on the project, it could consist of one or more notebooks, and/or (encouraged) functions and classes defined in separate .py modules.

Make sure you thoroughly document your code! Try to write self-explanatory code (meaningful variables names, logical flow...) and add the comments you feel necessary. It shouldn't just work, it should be readable - it is a good chance to try doing that well, as you will get feedback about it! If you write notebooks, make sure you use the markdown cells to describe the notebook content and to add all the required explanations to the analysis flow.

README.md

The project must feature a README.md in the repository with a (schematic) description of the project aims and structure. Ideally, after a brief description, in the README.md you should give some instructions about how to install and run the code. If you want, you can find here a markdown cheatsheet. For some random examples see here, or here for the descriptions of different kinds of projects).

Examples

To give an idea, reasonable projects could be like:

  • Writing a loading class for an experiment's data, and showcase its use in a notebook
  • Preliminary analysis of a dataset (with data loading, aggregation, plots...); either original data or from the web
  • Implementing a new experiment / preparing the material for an experiment (eg images)
  • Writing code for cool generative art using plotting functions
  • Refactoring some old code you wrote before (conceptual and not only cosmetic! Avoiding duplicated code, reusability, etc.)

Final presentations

We will organize a day for chilled, short (5 min) presentations of everyone's project after all people have submitted. There will be prizes (and beer)!