neu-dsg / dsg-mhs Goto Github PK

For this project (and generally, IMHO), in-code comments should be used primarily for detailed explanation of how something complicated works. Rule of thumb is that if it takes more than 15 minutes to figure out, or if you did research to find a solution, those should be in the in-code docs, with links.

Do that in as many places as possible.

If the same idea applies to an entire file or folder, add it as a README (or other markdown file) to the containing folder.

This should include information about what you learned, what will future developers need to learn, and other thoughts that will be helpful to a future Hany.

Create a data folder and add all the xml files we have to it. Create subfolders to match any folder structures that already exist, and use your judgement for creating new folders that will be useful organizationally.

A task list of things to explore and/or build. Links to making tasks issue will be helpful

Create a task list here for each jupyter notebook that we should concentrate on moving into Django. The list items will become issues for further discussion

• [ ]

For each notebook, document in a README the following:

• Description of what it does
  • general description of the input and output
  • a sense of its purpose: what does it make visible, or what basic task does it accomplish?
• What input files are required to use it
• Any questions about how it works or anything that requires some in-depth explanation

A template is in the Jupyter_Notebooks directory.

A task list of points of exploration, as issues. The issues should include

• what's possible with existing data
• what data enhancement would we like (and why)

• #12
• #13
• [ ]

A task list (preferably, but not necessarily linked to more precise issues) of refactoring tasks.