[Proposal]: Performance Profiling & Optimisation (Python)

[Robadob]

1. Lesson Topic

Performance Profiling & Optimisation (Python)

2. Lesson Language

English

3. Draft materials

https://github.com/RSE-Sheffield/pando-python https://rse.shef.ac.uk/pando-python/

4. Requirements for existing materials

• [X] do your lesson materials conform to our Code of Conduct?
• [X] are your materials already on GitHub and do they use The Carpentries lesson template or The Carpentries Workbench? (you can visit the Workbench tutorial to learn more about how to use our lesson infrastructure).

5. New repository creation

• [X] I need a new repository created

6. Transfer existing repository

• [x] my lesson meets both criteria in part 4 and I would like to transfer the repository to The Carpentries Incubator

7. Collaborators

@robadob

8. Info/Questions

Please fork the draft materials when creating the new repository, so that GitHub tracks the relationship and how ahead/behind the repo gets. I intend to maintain the original draft in parity with the fork, as it includes some Sheffield-specific pages around signing up to attend etc.

The existing "draft materials" use a custom Varnish to match the university of Sheffield's branding (where it was funded/developed). This isn't a well documented feature of Workbench, so I'm not sure whether that's permitted to stay in the incubator version (I'm not terribly fussed either way).

[tobyhodges]

Hey @Robadob! Thank you for submitting this lesson to The Carpentries Incubator.

You should have received an invitation to join a Team of maintainers for the lesson, as part of the carpentries-incubator organization on GitHub. After you have accepted that invitation, you should be able to fork the repository yourself into carpentries-incubator. When that is done, I will make sure that you retain the appropriate level of access to the repository: you will be given full administrative rights, and the collaborators you listed above will be given "Maintain" privileges.

The existing "draft materials" use a custom Varnish to match the university of Sheffield's branding (where it was funded/developed). This isn't a well documented feature of Workbench, so I'm not sure whether that's permitted to stay in the incubator version (I'm not terribly fussed either way).

Indeed! Improving that documentation is a task on my list. Maybe best to adjust the 'branding' on the Incubator repo back to carpentry: "incubator" so that it is easier to distinguish between the general purpose version of the lesson here, and the Sheffield-specific version you will be maintaining in parallel?

To keep in touch with The Carpentries curriculum community you may find it useful to join the incubator-developers list on The Carpentries TopicBox and/or the lesson-dev channel on The Carpentries Slack. Joining the Slack channel requires that you first become a member of that workspace.

I will leave this issue open until the transfer has been completed. If you have any questions about the process, or if you run into any trouble, please post back here and I will be happy to help you.

[Robadob]

Hi @tobyhodges,

I've now setup the fork, and pushed an extra commit that hides the disables the most obvious Sheffield stuff (there might be some in within the lesson content, but I'll review that within the near future).

The course is now live here. Although pushing the commit to remove Sheffield branding didn't automatically trigger the GH actions, so not sure if I've broken something during the fork. I've manually triggered a repeat of the initial deploy action, which is currently sitting in queue.

I've added some initial tags to the repo, I also added profiling, which is not found in the official tag list, but it seems most appropriate to me.

I think that's everything, I just need to work through my backlog of suggestions/improvements now but this has hopefully given me a kick.