Skip to content

Commit

Permalink
changes to index.md intro.html schedule.html
Browse files Browse the repository at this point in the history
  • Loading branch information
@D-Barradas
D-Barradas committed Aug 16, 2023
1 parent 8b42c45 commit 462c1ff
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 78 deletions.
6 changes: 3 additions & 3 deletions _config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ carpentry: "swc"
# dc-image: for Data Carpentry Image Processing
# swc-inflammation: for Software Carpentry based on the inflammation dataset
# swc-gapminder: for Software Carpentry based on the Gapminder dataset
curriculum: "FIXME"
curriculum: "swc-gapminder"

# If there is both an R and python official version of a curriculum
# (as listed on https://software-carpentry.org/lessons/ and
# https://datacarpentry.org/lessons/), change the
# value of the variable below ("flavor") to get the schedule and installation
# instructions updated accordingly (valid values are 'r' or 'python').
# Note: this is only for Data Carpentry and SWC at this time.
flavor: "FIXME"
flavor: "python"

# If the workshop will be a lesson pilot (for a new official lesson or
# a lesson in The Carpentries Incubator), set pilot to "true"
Expand All @@ -53,7 +53,7 @@ pilot: false
# Most workshops don't use extra pages. More information about extra
# pages are included in the README:
# https://github.com/carpentries/workshop-template#creating-extra-pages
title: "Workshop Title"
title: "Introduction to Conda for (Data) Scientists"

#------------------------------------------------------------
# Incubator workshop settings (only relevant for workshops teaching a lesson
Expand Down
51 changes: 38 additions & 13 deletions _includes/swc/intro.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,43 @@
<p>
<a href="{{site.swc_site}}">Software Carpentry</a>
aims to help researchers get their work done
in less time and with less pain
by teaching them basic research computing skills.
This hands-on workshop will cover basic concepts and tools,
including program design, version control, data management,
and task automation.
Participants will be encouraged to help one another
and to apply what they have learned to their own research problems.
The KAUST Visualization Lab is hosting an <em>Introduction to Conda for (Data) Scientists</em>
workshop. Conda is an open source package and environment management system that runs on
Windows, macOS and Linux. Conda installs, runs, and updates packages and their dependencies.
Conda easily creates, saves, loads, and switches between environments on your local computer.
While Conda was created for Python programs it can package and distribute software for any
languages such as R, Ruby, Lua, Scala, Java, JavaScript, C/ C++, FORTRAN. This lesson motivates
the use of Conda as a development tool for building and sharing project specific software
environments that facilitate reproducible (data) science workflows.
</p>
<p>
Topics covered will include
</p>
<ul>
<li>Getting Started with Conda</li>
<li>Working with Environments</li>
<li>Sharing Environments</li>
<li>Using Packages and Channels</li>
</ul>

<p>
This hands-on lesson is part of the <em>Introduction to Data Science Workshop Series</em>
being offered by KVL as part of our on-going efforts to build
capacity in core data science skills both at KAUST and within the Kingdom of Saudi Arabia (KSA).
</p>
<p>
The workshop curriculum largely follows the
<a href="https://carpentries-incubator.github.io/introduction-to-conda-for-data-scientists/">curriculum</a> developed by
<a href="{{site.swc_site}}">Software Carpentry</a>, a volunteer project dedicated to helping
researchers get their work done in less time and with less pain by teaching them basic research
computing skills.
</p>
<p>
This is a live-coding based workshop and learners are expected to work along with the instructor using freely
available cloud resources provided by the <a href="https://mybinder.readthedocs.io/en/latest/">Binder</a> project.
</p>

<p align="center">
<em>
For more information on what we teach and why,
please see our paper
"<a href="https://doi.org/10.1371/journal.pbio.1001745">Best Practices for Scientific Computing</a>".
For more information on what Software Carpentry teaches and why, please see their paper
"<a href="http://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.1001745">Best Practices for Scientific Computing</a>".
</em>
</p>
</p>
30 changes: 6 additions & 24 deletions _includes/swc/schedule.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,13 @@
<div class="col-md-6">
<h3>Day 1</h3>
<table class="table table-striped">
<tr> <td>Before</td> <td><a href="{{ site.pre_survey }}{{ site.github.project_title }}" target="_blank" rel="noopener noreferrer">Pre-workshop survey</a> </td> </tr>
<tr> <td>09:00</td> <td>Automating Tasks with the Unix Shell</td> </tr>
<tr> <td>10:30</td> <td>Morning break</td> </tr>
<tr> <td>11:00</td> <td>Automating Tasks with the Unix Shell (Continued)</td> </tr>
<tr> <td>12:00</td> <td>Lunch break</td> </tr>
<tr> <td>13:00</td> <td>Building Programs with Python</td> </tr>
<!-- <tr> <td>Before</td> <td><a href="{{ site.swc_pre_survey }}{{ site.github.project_title }}">Pre-workshop survey</a> </td> </tr> -->
<tr> <td>14:00</td> <td>Introduction to Conda</td> </tr>
<tr> <td>14:30</td> <td>Afternoon break</td> </tr>
<tr> <td>15:00</td> <td>Building Programs with Python (Continued)</td> </tr>
<tr> <td>16:00</td> <td>Wrap-up</td> </tr>
<tr> <td>16:30</td> <td>END</td> </tr>
</table>
</div>
<div class="col-md-6">
<h3>Day 2</h3>
<table class="table table-striped">
<tr> <td>09:00</td> <td>Version Control with Git</td> </tr>
<tr> <td>10:30</td> <td>Morning break</td> </tr>
<tr> <td>11:00</td> <td>Version Control with Git (Continued)</td> </tr>
<tr> <td>12:00</td> <td>Lunch break</td> </tr>
<tr> <td>13:00</td> <td>Managing Data with SQL</td> </tr>
<tr> <td>14:30</td> <td>Afternoon break</td> </tr>
<tr> <td>15:00</td> <td>Managing Data with SQL (Continued)</td> </tr>
<tr> <td>16:00</td> <td>Wrap-up</td> </tr>
<tr> <td>16:30</td> <td><a href="{{ site.post_survey }}{{ site.github.project_title }}" target="_blank" rel="noopener noreferrer">Post-workshop Survey</a></td> </tr>
<tr> <td>16:40</td> <td>END</td> </tr>
<tr> <td>14:45</td> <td>Reproducible Software Environments with Conda</td> </tr>
<tr> <td>15:55</td> <td>Wrap-up</td> </tr>
<tr> <td>16:00</td> <td>END</td> </tr>
<!-- <tr> <td>After</td> <td><a href="{{https://kaustforms.formstack.com/forms/intro_conda_for_data_science_fall_2022}}">Post-workshop survey</a> </td> </tr> -->
</table>
</div>
</div>
75 changes: 37 additions & 38 deletions index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,25 @@ layout: workshop # DON'T CHANGE THIS.
# More detailed instructions (including how to fill these variables for an
# online workshop) are available at
# https://carpentries.github.io/workshop-template/customization/index.html
venue: "FIXME" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
address: "FIXME" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
country: "FIXME" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
language: "FIXME" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "45" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "-1" # decimal longitude of the workshop venue (use https://www.latlong.net)
humandate: "FIXME" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "FIXME" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: FIXME # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
enddate: FIXME # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
instructor: ["instructor one", "instructor two"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
helper: ["helper one", "helper two"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
email: ["[email protected]","[email protected]"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["[email protected]", "[email protected]", "[email protected]"]
collaborative_notes: # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2015-01-01-euphoria)
venue: "KAUST Visualization Core Lab" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
address: "Auditorium 0215 between building 2 and 3 , KAUST, Thuwal, SA" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
country: "SA" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
language: "en" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "22.307845" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "39.105472" # decimal longitude of the workshop venue (use https://www.latlong.net)
humandate: "Sep 12, 2023" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "02:00 pm - 05:00 pm AST" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: 2023-09-12 # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
enddate: 2023-09-12 # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
instructor: ["Dr. Didier Barradas-Bautista", "TBD"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
# helper: ["helper one", "helper two"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
email: ["[email protected]","[email protected]"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["[email protected]", "[email protected]", "[email protected]"]
collaborative_notes: https://pad.carpentries.org/2023-09-03-kaust-vislab # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2015-01-01-euphoria)
eventbrite: # optional: alphanumeric key for Eventbrite registration, e.g., "1234567890AB" (if Eventbrite is being used)
---

---

{% comment %} See instructions in the comments below for how to edit specific sections of this workshop template. {% endcomment %}

{% comment %}
Expand All @@ -33,28 +35,7 @@ And run 'make workshop-check' *before* committing to make sure that changes are


{% comment %}
8< ============= For a workshop delete from here =============
For a workshop please delete the following block until the next dashed-line
{% endcomment %}


<div class="alert alert-danger">
This is the workshop template. Delete these lines and use it to
<a href="https://carpentries.github.io/workshop-template/customization/index.html">customize</a>
your own website. If you are running a self-organized workshop or have not put
in a workshop request yet, please also fill in
<a href="{{site.amy_site}}/forms/self-organised/">this workshop request form</a>
to let us know about your workshop and our administrator may contact you if we
need any extra information.
If this is a pilot workshop for a new lesson,
set the `pilot` field to `true` in `_config.yml`.
For workshops teaching a lesson in The Carpentries Incubator,
remember to uncomment the `incubator_lesson_site`, `incubator_pre_survey`, and `incubator_post_survey`
fields in `_config.yml`
</div>

{% comment %}
8< ============================= until here ==================
{% endcomment %}


Expand Down Expand Up @@ -126,7 +107,7 @@ This is a pilot workshop, testing out a lesson that is still under development.
{% comment %}
AUDIENCE

Explain who your audience is. (In particular, tell readers if the
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" %}
Expand Down Expand Up @@ -199,6 +180,23 @@ Modify the block below if there are any special 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 administrative privileges on.
<p>
<strong>For KAUSTians :</strong>
The University provides several resources for the participants to use during the workshop but you have to request the service the first time you use it <a href="https://waseet.kaust.edu.sa/idp/profile/SAML2/Redirect/SSO?execution=e1s1">here</a> :
</p>
<!-- create a list of three items -->
<table class="table table-striped">
<tr> <td> <a href="https://jupyter.kaust.edu.sa/hub/login"> Jupyter hub </a> </td> </tr>
<tr> <td> <a href="https://myws.kaust.edu.sa/" > Virtual machines </a> </td> </tr>
<tr> <td> <a href="https://github.com/kaust-vislab/kvl-binder-serv"> Binder </a> </td> </tr>
</table>
<strong>For remote students:</strong>
Participants must have access to a computer with a
Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on.
as well as a stable internet connection. Optionally, they can use the following resource <a href="https://mybinder.readthedocs.io/en/latest/">Binder</a> to run the code in the cloud.
<p>
<strong> Registration: </strong> Please use this link to register for the workshop <a href="https://kaustforms.formstack.com/forms/unix_shell_data_scientists_fall_2023">here</a>
</p>
{% else %}
Participants must have access to a computer with a
Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on.
Expand All @@ -212,6 +210,7 @@ ACCESSIBILITY
Modify the block below if there are any barriers to accessibility or
special instructions.
{% endcomment %}

<p id="accessibility">
<strong>Accessibility:</strong>
{% if online == "false" %}
Expand All @@ -222,14 +221,14 @@ special instructions.
<li>The room is wheelchair / scooter accessible.</li>
<li>Accessible restrooms are available.</li>
</ul>
<p>
<!-- <p>
Materials will be provided in advance of the workshop and
large-print handouts are available if needed by notifying the
organizers in advance. 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.
</p>
</p> -->
{% 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
Expand Down

0 comments on commit 462c1ff

Please sign in to comment.