Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/klieret/icsc-paradigms-and-patterns
Slides and exercises for the iCSC lecture "Software Paradigms and Programming Patterns"
https://github.com/klieret/icsc-paradigms-and-patterns
design-patterns design-patterns-python icsc icsc2020 lecture lecture-material lecture-notes paradigms
Last synced: 24 days ago
JSON representation
Slides and exercises for the iCSC lecture "Software Paradigms and Programming Patterns"
- Host: GitHub
- URL: https://github.com/klieret/icsc-paradigms-and-patterns
- Owner: klieret
- License: other
- Created: 2020-02-12T12:49:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T17:21:41.000Z (6 months ago)
- Last Synced: 2024-10-22T21:33:03.983Z (2 months ago)
- Topics: design-patterns, design-patterns-python, icsc, icsc2020, lecture, lecture-material, lecture-notes, paradigms
- Language: TeX
- Homepage:
- Size: 1.56 MB
- Stars: 14
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Programming Paradigms and Patterns
[](https://zenodo.org/badge/latestdoi/240011587)
[](https://results.pre-commit.ci/latest/github/klieret/icsc-paradigms-and-patterns/master)
[](https://github.com/klieret/icsc-paradigms-and-patterns/actions)
[](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project)
This repository contains lecture slides (both as source code and as rendered pdfs)
and exercises.
The course was first taught in September/October 2020 at the [iCSC 2020](https://indico.cern.ch/event/853710/).
**Recordings** of the lectures:
* [Programming Paradigms](https://cds.cern.ch/record/2736118)
* [Software Design Patterns](https://cds.cern.ch/record/2737225)
**Slides**: The final versions of the rendered slides at the time of the presentation are in the root directory of this repository. There are two versions, one with animations and one without (``*_handout.pdf``).
**Exercises**: See below.
## Getting help
During the event, there are two channels on CERN mattermost (you might need to create a CERN lightweight account, which is free for everyone):
* [Programming Paradigms](https://mattermost.web.cern.ch/csc/channels/programming-paradigms)
* [Software Design Patterns](https://mattermost.web.cern.ch/csc/channels/software-design)
After the event, you can open an issue in this repository.
## Running the exercises
The exercises come with solutions for you to compare to. If you have any questions, please join the exercise discussion slot.
If you're completely new to this, use option 1 or 2. If you already have python and Jupyter set up on your computer, we recommend option 3. Note that your changes are not saved automatically in the first two options!
### Option 1: Using binder
This means you don't have to install anything, but you can simply use the binder service
to provide you with a Jupyter environment in your browser.
It might be a bit slow to start up, but once it's running you're ready to go!
Simply click on the following link:
[](https://mybinder.org/v2/gh/klieret/icsc-paradigms-and-patterns/master)
You should see something like this:
After some time (don't worry if it takes 5 minutes) you are brought to the Jupyter server:
Navigate on ``exercises`` and then click on one of the two notebooks (``patterns.ipynb`` or ``paradigms.ipynb``) to start your training!
If you've never use Jupyter notebook, you can also do [this training](https://mybinder.org/v2/gh/ipython/ipython-in-depth/master?filepath=binder/Index.ipynb) or take a look at [the documentation](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html). But basically you can execute a cell by hitting ``Shift+Enter`` and add cells with the menu.
### Option 2: Google colab
Simply click the link (you need to log in to your google account though)
* [Programming Paradigms ](https://colab.research.google.com/github/klieret/icsc-paradigms-and-patterns/blob/master/exercises/paradigms.ipynb)
* [Software Design Patterns ](https://colab.research.google.com/github/klieret/icsc-paradigms-and-patterns/blob/master/exercises/patterns.ipynb)
If you've never used Google colab, you can also go to [this page](https://colab.research.google.com/notebooks/intro.ipynb) and try it out (but it's very similar to Jupyter notebooks if you're familiar with that).
### Option 3: Local run
You need to have python3 and its package manager pip3.
Clone the repository
```sh
git clone [email protected]:klieret/icsc-paradigms-and-patterns.git
cd icsc-paradigms-and-patterns
```
Make sure you have the required python packages:
```sh
pip3 install -r requirements.txt
```
Then run the Jupyter notebook
```sh
jupyter-notebook
```
It should open in your browser.
## Generating lecture slides from source
You need to use [XeLaTeX](https://en.wikipedia.org/wiki/XeTeX):
```sh
cd latex
mkdir -p build && xelatex --output-directory build -shell-escape software_patterns.tex
mkdir -p build && xelatex --output-directory build -shell-escape programming_paradigms.tex
```
The ``-shell-escape`` flag is needed for code highlighting. You might need to install
the pygments package.
The slides work with overlays (partial reveals of bullet points and other elements).
As this is less practical for studying yourself, take a look at the main ``.tex`` file
and change ``\handoutfalse`` to ``\handouttrue`` if needed.
## Developing this further
We are planning to convert this into a training similar to that of the [Software Carpentry](https://software-carpentry.org/) in order to be included in the [HSF curriculum](https://hepsoftwarefoundation.org/training/curriculum.html). Help is much appreciated.
If you have any particular comments, feel free to open an issue on github for this repository.
## Citation & License
Licensed as CC BY 4.0, see file ``license.md``. Please use the following zenodo ID to cite this
work:
[](https://zenodo.org/badge/latestdoi/240011587)