Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new file for python template episode #1

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

sjvrijn
Copy link
Contributor

@sjvrijn sjvrijn commented Oct 14, 2024

Closes #25

Just a quick outline file for an episode on the python template:

  • creating a project
  • creating a project with smp tool answer file
  • updating a project to add features afterwards

Copy link

github-actions bot commented Oct 14, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/SS-NES/SS-NES-lesson/compare/md-outputs..md-outputs-PR-1

The following changes were observed in the rendered markdown documents:

 config.yaml              |   1 +
 md5sum.txt               |   3 +-
 python-template.md (new) | 194 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 197 insertions(+), 1 deletion(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2025-02-07 07:51:58 +0000

github-actions bot pushed a commit that referenced this pull request Oct 14, 2024
@sjvrijn sjvrijn marked this pull request as draft October 28, 2024 09:33
@sjvrijn
Copy link
Contributor Author

sjvrijn commented Oct 28, 2024

Note from discussion: the python template assumes knowledge of e.g. copier and pipx. Any tool we decide to use in this lesson material should be properly explained!


:::::::::::::::::::::::::::::::::::::: questions

- How can you quickly set up a new Python repository that follows best practices?

Choose a reason for hiding this comment

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

If we connect it also to the SMP we can add the question:
How to create a new Python repository that covers your needs and follows best practices

@sjvrijn sjvrijn force-pushed the python-template-episodes branch from 6357989 to e8769e4 Compare February 4, 2025 10:48
github-actions bot pushed a commit that referenced this pull request Feb 4, 2025
@sjvrijn sjvrijn force-pushed the python-template-episodes branch from e8769e4 to b5c0601 Compare February 4, 2025 11:15
github-actions bot pushed a commit that referenced this pull request Feb 4, 2025
@sjvrijn sjvrijn force-pushed the python-template-episodes branch from b5c0601 to 8363e0e Compare February 4, 2025 13:22
github-actions bot pushed a commit that referenced this pull request Feb 4, 2025
github-actions bot pushed a commit that referenced this pull request Feb 4, 2025
@sjvrijn sjvrijn force-pushed the python-template-episodes branch from f83f355 to b9f9e7e Compare February 5, 2025 10:01
github-actions bot pushed a commit that referenced this pull request Feb 5, 2025
github-actions bot pushed a commit that referenced this pull request Feb 7, 2025
@sjvrijn sjvrijn marked this pull request as ready for review February 7, 2025 07:54
:::::::::::::::::::::::: solution

```bash
copier copy gh:nlesc/python-template path/to/destination

Choose a reason for hiding this comment

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

Some word of explanation to the path/to/destination will make it clearer that it is not a path in the github of the python-template e.g. path/to/your/code/project

Copy link

@chStaiger chStaiger left a comment

Choose a reason for hiding this comment

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

Nice! No major comments. I like the two exercises that show the usefulness of the yaml files and connect the creation of the repo to the software management plan!

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.

Add (separate) episode on using SMP output with (NLeSC) Python Template
2 participants