Skip to content

Commit a6ff082

Browse files
committed
Revert "Apply patch removing Shef specific content from fork"
This reverts commit 6e84e3d.
1 parent a425e57 commit a6ff082

File tree

4 files changed

+36
-9
lines changed

4 files changed

+36
-9
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,32 @@ See [Contributing](CONTRIBUTING.md)
1717
## Acknowledgements
1818

1919
The initial development of this course was funded by the University of Sheffield, to support training initiatives for users of their [Stanage HPC cluster](https://docs.hpc.shef.ac.uk/en/latest/stanage/index.html).
20+
21+
## Building the Site Locally
22+
23+
If you are making complex changes, and wish to build the site locally the below instructions can be followed.
24+
25+
26+
### Setup
27+
28+
Both of these steps should be followed within `rterm`.
29+
30+
```r
31+
# Setup mirrors
32+
options(repos = c(
33+
carpentries = "https://carpentries.r-universe.dev/",
34+
CRAN = "https://cran.rstudio.com/"
35+
))
36+
# Setup install from github
37+
install.packages("devtools")
38+
library(devtools)
39+
# Install Uni of Shef Varnish theme
40+
install_github("RSE-Sheffield/uos-varnish")
41+
# Install remaining official carpentries packages
42+
install.packages(c("sandpaper", "tinkr", "pegboard"))
43+
```
44+
## Development Server
45+
46+
```r
47+
sandpaper::serve()
48+
```

config.yaml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ episodes:
7676
# Information for Learners
7777
learners:
7878
- setup.md
79-
# - registration.md # University of Sheffield specific registration procedure
79+
- registration.md
8080
- technical-appendix.md
8181
- acknowledgements.md
8282
- ppp.md
@@ -93,9 +93,8 @@ profiles:
9393
# This space below is where custom yaml items (e.g. pinning
9494
# sandpaper and varnish versions) should live
9595

96-
# These config items are used to deploy the University of Sheffield varnish theme
97-
#varnish: RSE-Sheffield/uos-varnish@main
98-
#url: 'https://rse.shef.ac.uk/pando-python'
96+
varnish: RSE-Sheffield/uos-varnish@main
97+
url: 'https://rse.shef.ac.uk/pando-python'
9998

10099
analytics: |
101-
<script defer src="https://cloud.umami.is/script.js" data-website-id="2b561bd0-0d7a-436b-a18d-d19c94785362"></script>
100+
<script defer src="https://cloud.umami.is/script.js" data-website-id="95b3ca57-3bd9-47b0-b1ca-fe819ef65c80"></script>

episodes/optimisation-conclusion.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ An overview of how Python operates and the most important practices for achievin
2424
Hopefully with the information from this course you will be in a better position to investigate and optimise the performance of your own code.
2525

2626
This course's website can be used as a reference manual when profiling your own code.
27-
<!--
27+
2828
::::::::::::::::::::::::::::::::::::: callout
2929

3030
## Your Feedback is Required!
@@ -34,7 +34,6 @@ Please complete [this Google form](https://forms.gle/C82uWBEou3FMrQs99) to let u
3434
Your feedback enables us to improve the course for future attendees!
3535

3636
:::::::::::::::::::::::::::::::::::::::::::::
37-
-->
3837

3938
::::::::::::::::::::::::::::::::::::: keypoints
4039

index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ If you are now comfortable using Python, this course may be of interest to suppl
1717

1818
This is an all-day course, however it normally finishes by early afternoon.
1919

20+
If you would like to register to take the course, check the [registration information](learners/registration.md).
2021
<!-- TODO: course duration? -->
2122
<!-- TODO: confident code syllabus? -->
2223

@@ -46,8 +47,7 @@ Before joining Performance Profiling & Optimisation (Python) Training, participa
4647
- implement basic algorithms in Python.
4748
- follow the control flow of Python code, and dry run the execution in their head or on paper.
4849

49-
See Software Carpentry's [Python novice course](https://swcarpentry.github.io/python-novice-inflammation/) for help with learning these skills.
50-
50+
See the [Research Computing Training Hub](https://sites.google.com/sheffield.ac.uk/research-training/research-training) for other courses to help with learning these skills.
5151
<!-- TODO: could make a dedicated page (like https://carpentries.github.io/lesson-development-training/markdown-github-primer.html) that highlights specific courses/resources. -->
5252

5353
::::::::::::::::::::::::::::::::::::::::::::::::::

0 commit comments

Comments
 (0)