Feedback Day 2

General

• There are two text files in the repo charis4.txt and charis4.dat that should not be there. If they are needed for day2, they should live within that folder.
• While this is mean to be taught, the material should be sort of self-explanatory thanks to comments and explanation. Day 1 is pretty good, but this lesson seems to have been rush through...

Lesson material

• This lesson is pretty vague. It is OK if most of it will be going through the example code, but there should be some context and clear purpose - not necessarily in the form of learning outcomes, but along those lines.
• For this lesson it is necessary to have numpy installed in the virtual environment. This should be explained - and remind people to activate the environment.

Code

• The code should be clearly commented, as it was in the code for Day 1, specially the new bits.
• Functions should include docstrings to document them properly, as well as their arguments - it is not just about writing code that works, but also about showing good coding practices.
• Given that you have numpy now, create the data using np.arange or np.linspace
• It is totally unclear what ABP is or why it is created the way it is created (where does 91.5061 comes from?)
• Given that Dearpygui uses tags to identify different elements in the GUI, so they can be updated appropiately, I would define this tags gloibally, so they can be re-used without risk of making typos. For example, define SERIES_TAG = "series_tag" and then use everywhere else SERIES_TAG.
• While these are meant to show simple scripts to create GUIs, in the spirit of good coding practices I would organise the scripts as:

import ...

# set CONSTANTS here, if any

# define functions here
# the more code you can put within functions with a specific purpose, the better

if __name__ == "__main__":

# put the rest of your script here
# including all the steps required to create and run the dearpygui app

Here you can find more info about it. As I say, I'm aware these are just simple examples, yet I think it is a useful good approach to adopt ASAP.

Esamina prima il materiale della lezione Day 2 e i file charis4.txt e charis4.dat nella root. Verifica il contesto della lezione, le indicazioni sull’ambiente numpy, i commenti, i docstring, la creazione dei dati, la spiegazione di ABP, le costanti dei tag e la struttura dello script rispetto alla checklist. Il lavoro è completato quando ogni elemento di feedback elencato è stato affrontato e la lezione rimane comprensibile come esempio didattico.