PublicationHackathon

SasView Publication Hackathon (Oct 1-2 2020)

General organization:

1. We will use overleaf for manuscript writing. Email Tim if you don't have access to the manuscript.
2. We will use Kanban board https://github.com/orgs/SasView/projects/3
3. We will follow regular workflow with "To Do", "In Progress", "Review" and "Done" columns
4. Sections ready for review should be moved to "Review" column. One can suggest/assign reviewer or leave it unassigned for someone to take the task. Hackathon managers may also assign reviewers.
5. Assign yourself to the tasks you work on
6. The communication will be done through SasView slack channel (manuscript_chat)
7. There will be no daily meeting

Journal

1. We are planning to submit manuscript to Journal of Applied Crystallography
2. One may want to consult guides for authors https://journals.iucr.org/j/services/notesforauthors.html

Scope:

1. We will primarily focus on individual sections. Don't worry too much about overall structure (of course one should be inspired)
2. We are aiming at fleshing out complete story. Final tuning will be done after hackathon by subset of people

Figures:

1. Try to use sasview graphics (e.g. plots) for producing figures
2. At this stage we don't know, which figures will go to the final version - don't spend too much time tweaking them!
3. Write in the comments (in manuscript) any information that may help reproducing figure (e.g. q range used to produce plot or model parameters).
4. Upload figure to the overleaf (images folder)
5. Journal guideline for figures https://journals.iucr.org/j/services/help/artwork/guide.html

TeX Tips:

1. Put citations before punctuation: "as Smith wrote \cite{Smith1857}."
2. Put footnotes after punctuation (but don't overuse them!): "with his pants on.\footnote{no idea why pants are relevant}"
3. Avoid multi-character variables as $qmax$ will look like q × m × a × x.
4. Mark up non-variable subscripts/superscripts as being roman not italic: $Q_{max}$ → $Q_\mathrm{max}$
5. Use our macros to easily do consistent formatting of common elements we must discuss:

• A GUI element: \svgui{button}
• A Python code module: \svcode{sasview.qtgui}
• A Python function: \svfunc{Iq}
• A filesystem path or filename: \svpath{.sasview/config}
• A variable that is shown in the UI: \svvar{d2}

References

1. Add references in bibtex format to iucr.bib file on Overleaf.
2. Then you can cite in text by writing \cite{Moeller2017a}

Author list

1. Please make sure your name and affiliation appears on the authors list
2. Current order of authors is not final. The order will be decided at the later stage.

Review

1. Read the section all the way through once. 2 Then start back at the first paragraph - accept everything unless it is just plain wrong. The edits tracking just gets so full it is very hard to see the comments in that forest.
2. Then add a comment or two if appropriate asking for fixes. Continue with the next paragraph etc. until the end.
3. Then post a summary on the corresponding github issue page and notify authors (since they are no longer assigned they may not see the issue pop up?).
4. Next the authors look at it and decide what to do ..just like in a PR. They can make changes which can then be further reviewed and/or reply to the comment (e.g. why they don’t think a change should be made)
5. When all agree the issue should be closed as resolved.
6. Once all comments are closed on the section and all changes are accepted or rejected, the REVIEWER moves it to the DONE column.