| layout | venue | address | country | language | latitude | longitude | humandate | humantime | startdate | enddate | instructor | helper | collaborative_notes | eventbrite | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
workshop |
UKAEA |
Culham Science Centre, E6, Training Room |
GB |
English |
51.65713 |
-1.23002 |
3, 4, 12, 13, 20, 21 June 2024 |
13:00 - 16:30 BST (UTC+1) |
2024-06-03 |
2024-06-21 |
|
|
COMING SOON |
{% comment %} See instructions in the comments below for how to edit specific sections of this workshop template. {% endcomment %}
{% comment %} HEADER
Edit the values in the block above to be appropriate for your workshop. If the value is not 'true', 'false', 'null', or a number, please use double quotation marks around the value, unless specified otherwise. And run 'make workshop-check' before committing to make sure that changes are good. {% endcomment %}
{% comment %} Check DC curriculum {% endcomment %}
{% if site.carpentry == "dc" %} {% unless site.curriculum == "dc-astronomy" or site.curriculum == "dc-ecology" or site.curriculum == "dc-genomics" or site.curriculum == "dc-socsci" or site.curriculum == "dc-geospatial" %}
_config.yml file (current value in _config.yml: "{{ site.curriculum }}", possible values: dc-astronomy, dc-ecology, dc-genomics, dc-socsci, or dc-geospatial). After editing this file, you need to run make serve again to see the changes reflected.
{% comment %} Check SWC curriculum {% endcomment %}
{% if site.carpentry == "swc" %} {% unless site.curriculum == "swc-inflammation" or site.curriculum == "swc-gapminder" %}
_config.yml file (current value in _config.yml: "{{ site.curriculum }}", possible values: swc-inflammation, or swc-gapminder). After editing this file, you need to run make serve again to see the changes reflected.
{% comment %} EVENTBRITE
This block includes the Eventbrite registration widget if 'eventbrite' has been set in the header. You can delete it if you are not using Eventbrite, or leave it in, since it will not be displayed if the 'eventbrite' field in the header is not set. {% endcomment %} {% if page.eventbrite %} Some adblockers block the registration window. If you do not see the registration box below, please check your adblocker settings.
<iframe src="https://www.eventbrite.com/tickets-external?eid={{page.eventbrite}}&ref=etckt" frameborder="0" width="100%" height="280px" scrolling="auto"> </iframe> {% endif %}{% comment %} INTRODUCTION
Edit the general explanatory paragraph below if you want to change the pitch. {% endcomment %} {% if site.carpentry == "swc" %} {% include swc/intro.html %} {% elsif site.carpentry == "dc" %} {% include dc/intro.html %} {% elsif site.carpentry == "lc" %} {% include lc/intro.html %} {% endif %}
{% if site.pilot %} This is a pilot workshop, testing out a lesson that is still under development. The lesson authors would appreciate any feedback you can give them about the lesson content and suggestions for how it could be further improved. {% endif %}
{% comment %} AUDIENCE
Explain who your audience is. (In particular, tell readers if the workshop is only open to people from a particular institution. {% endcomment %} {% if site.carpentry == "swc" %} {% include swc/who.html %} {% elsif site.carpentry == "dc" %} {% include dc/who.html %} {% elsif site.carpentry == "lc" %} {% include lc/who.html %} {% endif %}
{% comment %} LOCATION
This block displays the address and links to maps showing directions if the latitude and longitude of the workshop have been set. You can use https://www.latlong.net/ to find the lat/long of an address. {% endcomment %} {% assign begin_address = page.address | slice: 0, 4 | downcase %} {% if page.address == "online" %} {% assign online = "true_private" %} {% elsif begin_address contains "http" %} {% assign online = "true_public" %} {% else %} {% assign online = "false" %} {% endif %} {% if page.latitude and page.longitude and online == "false" %}
Where: {{page.address}}. Get directions with OpenStreetMap or Google Maps.
{% elsif online == "true_public" %}Where: online at {{page.address}}. If you need a password or other information to access the training, the instructor will pass it on to you before the workshop.
{% elsif online == "true_private" %}Where: This training will take place online. The instructors will provide you with the information you will need to connect to this meeting.
{% endif %}{% comment %} DATE
This block displays the date and links to Google Calendar. {% endcomment %} {% if page.humandate %}
When: {{page.humandate}}. Calendar invites will be sent to all participants.
{% endif %}{% comment %} SPECIAL REQUIREMENTS
Modify the block below if there are any special requirements. {% endcomment %}
Requirements: {% if online == "false" %} Participants must bring a laptop with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have a user account on. {% else %} Participants must have access to a computer with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.). {% endif %} They should have a few specific software packages installed (listed below). UKAEA-managed Windows machines have restricted permissions but should be able to install the requisite software. Please see instructions below for further details.
{% comment %} ACCESSIBILITY
Modify the block below if there are any barriers to accessibility or special instructions. {% endcomment %}
Accessibility: {% if online == "false" %} We are committed to making this workshop accessible to everybody. If we can help making learning easier for you (e.g. sign-language interpreters, lactation facilities) please get in touch (using contact details below) and we will attempt to provide them.
{% else %} We are dedicated to providing a positive and accessible learning environment for all. Please notify the instructors in advance of the workshop if you require any accommodations or if there is anything we can do to make this workshop more accessible to you. {% endif %}{% comment %} CONTACT EMAIL ADDRESS
Display the contact email address set in the configuration file. {% endcomment %}
Contact: Please email {% if page.email %} {% for email in page.email %} {% if forloop.last and page.email.size > 1 %} or {% else %} {% unless forloop.first %} , {% endunless %} {% endif %} {{email}} {% endfor %} {% else %} to-be-announced {% endif %} for more information.
Roles: To learn more about the roles at the workshop (who will be doing what), refer to our Workshop FAQ.
{% comment %} WHO CAN ATTEND?
If you would like to specify who can attend the workshop, you can use the section below.
Move the 'endcomment' tag above the beginning of the following
tag to make this section visible.
Edit the text to match who can attend the workshop. For instance:
- This workshop is open to affiliates to ABC university.
- This workshop is open to the public.
- If you are interested in attending this workshop, contact [email protected] for more information
Who can attend?: This workshop is open to ....
{% endcomment %}{% comment%} CODE OF CONDUCT {% endcomment %}
Everyone who participates in Carpentries activities is required to conform to the Code of Conduct. This document also outlines how to report an incident if needed.
Report a Code of Conduct Incident
{% comment %} SETUP
Delete irrelevant sections from the setup instructions. Each section is inside a 'div' without any classes to make the beginning and end easier to find.
This is the other place where people frequently make mistakes, so please preview your site before committing, and make sure to run 'tools/check' as well. {% endcomment %}
To participate in this {% if site.carpentry == "swc" %} Software Carpentry {% elsif site.carpentry == "dc" %} Data Carpentry {% elsif site.carpentry == "lc" %} Library Carpentry {% endif %} workshop, you will need access to software as described below. In addition, you will need an up-to-date web browser.
{% if site.carpentry == "swc" %} {% include swc/setup.html %} {% elsif site.carpentry == "dc" %} {% include dc/setup.html %} {% elsif site.carpentry == "lc" %} {% include lc/setup.html %} {% elsif site.carpentry == "incubator" %} All non-Windows users, please check the note below about IDEs, then head to the "Setup" page of [the lesson site]({{ site.incubator_lesson_site }}setup) for instructions to follow to obtain the software and data you will need to follow the lesson. For Windows users, please see the note immediately below. We recommend that you use your work laptop for the course and run the software required directly on that.
We appreciate that some participants will work on Linux clusters on a regular basis (e.g. freia, heimdall, cumulus) and will therefore want to do the course work from there. Whilst this is possible, the Python installation on these clusters is not in a suitable state for the course. We have frequently run into problems trying to complete the course content in these environments. Therefore, we strongly discourage you from using one of these clusters at this time. If you still wilfully choose to work on a cluster, please be aware our support for you will be limited.1
It has been our experience that installing GitBash as recommended in the course setup is not a workable option. Instead, learners have had much less trouble if they use WSL (Windows Subsytem for Linux) and connect the VS Code IDE to that. We therefore recommend the following setup steps:
Follow the instructions to install WSL2 on your UKAEA laptop if you don't already have it. You do not need to use one of the pre-built distributions. Just use the Ubuntu distribution from the Windows Store.
Follow the link at the bottom of that guide to get VS Code connected to WSL2. Within WSL2, we recommend you work within the default home directory that the terminal places you in. Do not work from a directory in your roaming profile, shared home directory, or OneDrive synchronised directory.
Alternatively, if you prefer PyCharm as your IDE, then you can install it within WSL and launch it from there:
wget https://download.jetbrains.com/python/pycharm-community-2024.1.1.tar.gz sudo tar xzf pycharm-*.tar.gz -C /opt/ alias pycharm=/opt/pycharm-community-2024.1.1/bin/pycharm.sh # Put this into .bashrc pycharmBy default, WSL2 should automatically be able to launch graphical applications, but this is new functionality and not yet reliable, so please reach out for help if you encounter problems. Make sure you have set the default WSL version to
2.If you have any problems along the way, contact one of the course helpers, or raise it at the first session.
If the above fails, you can fall back to the option of using GitBash and a local Python installation:
- Git for Windows can be installed using the Software Center/Application Catalog.
- You can download and run a standard Python installer from https://www.python.org/downloads/windows/, but should ensure that the option to install for all users is not selected (to avoid the need for admin privileges).
- Get your IDE. We recommend VS Code which can be installed from the Windows Store. The PyCharm installer can be run using your standard login (and without an admin account). It is important to choose an installation path where you have write permissions (i.e. not the default path). The PyCharm installer probably won't run perfectly without admin rights, but our testing has shown that it does yield a functional application. In particular, you might notice it fails to create a shortcut from the start menu. {: .callout}
There are two Integrated Development Environments (IDEs) that are supported for this course, and we recommend that you use one of them:
- JetBrains' PyCharm: this is the one recommended in the course setup pages, and it is the IDE used throughout the examples in the course content. All figures and instructions relate to it.
- Microsoft's VSCode: a widely used IDE and likely the most popular at UKAEA. Instructions for getting set up with it have recently been added to the "Extras" of the course. As you go through the course and features of PyCharm are being explained, you can use that document to get the analogous features in VSCode. This will of course require switching between between webpages, so the experience will not be as seamless. A better UX is in our long term plans.
However, because this is an intermediate-level course, we expect that a number of participants will already have some experience using an IDE or comparable advanced code editor (e.g. Vim, Emacs). Therefore, you are welcome to use your editor of choice for the course if you are confident that you can achieve similar functionality that is described for PyCharm:
- Syntax highlighting, indentation, and autocompletion
- Recognition of virtual environments and setting the correct Python interpreter
- Running the Python debugger from the IDE and setting breakpoints at specific lines
- Integration with pytest and the ability to launch individual tests from the editor
Also, you must accept the provision that we will only support the two IDEs above. Regardless of your decision, we recommend that you still install one of the editors above as a fallback. {: .callout}
{% endif %}
{% comment %} For online workshops, the section below provides:
- installation instructions for the Zoom client
- recommendations for setting up Learners' workspace so they can follow along the instructions and the videoconferencing
If you do not use Zoom for your online workshop, edit the file
_includes/install_instructions/videoconferencing.html
to include the relevant installation instrucctions.
{% endcomment %}
{% if online != "false" %}
{% include install_instructions/videoconferencing.html %}
{% endif %}
{% comment %} These are the installation instructions for the tools used during the workshop. {% endcomment %}
We maintain a list of common issues that occur during installation as a reference for instructors that may be useful on the Configuration Problems and Solutions wiki page.
{% comment %} Collaborative Notes
If you want to use an Etherpad, go to
https://pad.carpentries.org/YYYY-MM-DD-site
where 'YYYY-MM-DD-site' is the identifier for your workshop, e.g., '2015-06-10-esu'.
Note we also have a CodiMD (the open-source version of HackMD) available at https://codimd.carpentries.org {% endcomment %} {% if page.collaborative_notes %}
We will use this collaborative document for chatting, taking notes, and sharing URLs and bits of code.
{% endif %}
{% comment %} SURVEYS - DO NOT EDIT SURVEY LINKS {% endcomment %}
There will then be a post-course survey to collect your feedback about how the sessions went.
{% if site.carpentry == "incubator" %} {% elsif site.incubator_pre_survey or site.incubator_post_survey %}{% comment %} SCHEDULE
Show the workshop's schedule.
Small changes to the schedule can be made by modifying the
schedule.html found in the _includes folder for your
workshop type (swc, lc, or dc). Edit the items and
times in the table to match your plans. You may also want to
change 'Day 1' and 'Day 2' to be actual dates or days of the
week.
For larger changes, a blank template for a 4-day workshop
(useful for online teaching for instance) can be found in
_includes/custom-schedule.html. Add the times, and what
you will be teaching to this file. You may also want to add
rows to the table if you wish to break down the schedule
further. To use this custom schedule here, replace the block
of code below the Schedule <h2> header below with
{% include custom-schedule.html %}.
{% endcomment %}
{% include custom-schedule.html %}
This workshop is teaching a lesson in The Carpentries Incubator. Please check [the lesson homepage]({{ site.incubator_lesson_site }}) for a more detailed list of lesson sections and estimated timings.
{% comment %} Edit/replace the text above if you want to include a schedule table. See the contents of the _includes/custom-schedule.html file for an example of how one of these schedule tables is constructed. {% endcomment %}
{% if site.pilot %} The lesson taught in this workshop is being piloted and a precise schedule is yet to be established. The workshop will include regular breaks. Please contact the workshop organisers if you would like more information about the planned schedule. {% endif %}
Footnotes
-
There is ongoing work to improve the Python installation on UKAEA clusters, so we hope it will soon be possible to offer this as a viable option again. ↩