Skip to content

Create course slides#7

Draft
jackdfranklin wants to merge 1 commit intomainfrom
issue5_create_slides
Draft

Create course slides#7
jackdfranklin wants to merge 1 commit intomainfrom
issue5_create_slides

Conversation

@jackdfranklin
Copy link
Copy Markdown
Collaborator

This PR will resolve #5.

The slides are currently written in markdown with the intention of using pandoc to convert to the final content format.

@jackdfranklin
Copy link
Copy Markdown
Collaborator Author

To discuss:

  • Is there any content/topic we need to add
  • Is there anything we can/should remove
  • Does the order/structure make sense
  • What format should we use (markdown vs latex)

Comment thread src/slides.md
# A likely scenario

- You have just joined a new research group as a Student/Researcher/PI.
- The group use a custom pipeline/setup to perform their data analysis/simulations.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- The group use a custom pipeline/setup to perform their data analysis/simulations.
- The group use a custom pipeline/setup to perform their data analysis/simulations.
- You are reading their latest paper, and want to reproduce one of their figures - your task is to introduce better data and adapt the algorithm, and add a new line to show the improvement.

Comment thread src/slides.md

# Version Control

- First put things into VC
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- First put things into VC
- First put things into version control (e.g. Github, Gitlab, Bitbucket, Codeberg)

Comment thread src/slides.md
# Version Control

- First put things into VC
- Then any changes/fixes can be tracked
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also something about better collaboration

Comment thread src/slides.md
- Basic documentation
- Project files (e.g. project.toml for python etc)
- System dependencies (nix/guix/docker?)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add something about automatisation - creating (at least) scripts to run the simulation pipeline, produce figures etc

Comment thread src/slides.md
- Accessibility
- Interoperability
- Reuse

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notebooks and containers

Comment thread src/slides.md
- Interoperability
- Reuse

$-- Maybe we should look at this retrospectively, and see what elements we covered and
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reproducibility reviews - let new team members run the code according to documentation, and raise issues for things that are not clear/outdated.

Also, point towards reprohacks and other reproducibility initiatives.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create slides

2 participants