From b490a66f041753b6e8ff5de3a5937c18da42b4f0 Mon Sep 17 00:00:00 2001 From: Repo Updater <noreply@mpcdf.mpg.de> Date: Fri, 15 Nov 2024 08:48:48 +0100 Subject: [PATCH] 815c3f32 update README.md and environment.yml --- README.md | 21 ++++++++++++--------- environment.yml | 5 +++-- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4730d3e..ab8e92c 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ Welcome to the MPCDF **Python for HPC** course! ## Authors -* 2022 - 2023 Sebastian Kehl (sebastian.kehl@mpcdf.mpg.de) +* 2022 - 2024 Sebastian Kehl (sebastian.kehl@mpcdf.mpg.de) * 2020 Rafael Lago -* 2018 - 2023 Sebastian Ohlmann (sebastian.ohlmann@mpcdf.mpg.de) -* 2018 - 2023 Klaus Reuter (klaus.reuter@mpcdf.mpg.de) +* 2018 - 2024 Sebastian Ohlmann (sebastian.ohlmann@mpcdf.mpg.de) +* 2018 - 2024 Klaus Reuter (klaus.reuter@mpcdf.mpg.de) [Max Planck Computing and Data Facility, Garching](https://mpcdf.mpg.de/) @@ -56,21 +56,24 @@ Welcome to the MPCDF **Python for HPC** course! This course is largely based on our experience from daily work. In addition, the following sources were used: -* *High Performance Python, Practical Performant Programming for Humans*, Micha Gorelick, Ian Ozsvald, O'Reilly Media; 2014. (In particular, parts of the diffusion example are discussed similarly to the presentation in this book.) +* *High Performance Python, Practical Performant Programming for Humans*, Micha Gorelick, Ian Ozsvald, O'Reilly Media; Second Edition, 2020. (In particular, parts of the diffusion example are discussed similarly to the presentation in this book.) * *A Whirlwind Tour of Python*, Jake VanderPlas, O'Reilly Media, 2016. * official documentation of Python, NumPy, SciPy, Cython, Numba, mpi4py, etc. -Other minor sources are referenced in the notebooks. +Other (minor) sources are referenced directly in the notebooks. ## Software prerequisites ### Python packages The examples discussed in this course are based on Python 3 and NumPy, SciPy, -Cython, Numba, matplotlib, and few more. -To conveniently get access to all those packages, you can e.g. download and install -Anaconda Python or a similar distribution and add additional required packages -using `pip` or `conda`. The 'environment.yml' file can be used for `conda`. +Cython, Numba, matplotlib, mpi4py, Dask, and few more. + +To conveniently get access to all the required packages, users can download and install +[Miniforge](https://conda-forge.org/miniforge/) -- which is a free alternative to +commercial Python distributions -- and use `conda` or `mamba` together with the file +`environment.yml` from this repository to create a local +[software environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file). ### Jupyter presentation via RISE diff --git a/environment.yml b/environment.yml index e08867b..4f31eed 100644 --- a/environment.yml +++ b/environment.yml @@ -1,9 +1,10 @@ -# Packages required for "Python for HPC" +# Packages required for running the examples from MPCDF's Python for HPC course: name: pyhpc channels: - conda-forge + - nodefaults dependencies: - - python=3.10 + - python=3.12 - pip - libopenblas=*=*openmp* - numpy -- GitLab