https://github.com/scientificcomputing/mpi-tutorial
An MPI tutorial in Python
https://github.com/scientificcomputing/mpi-tutorial
fenicsx ipyparallel mpi mpi4py python
Last synced: 2 months ago
JSON representation
An MPI tutorial in Python
- Host: GitHub
- URL: https://github.com/scientificcomputing/mpi-tutorial
- Owner: scientificcomputing
- License: mit
- Created: 2023-04-11T14:20:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T14:31:55.000Z (over 2 years ago)
- Last Synced: 2026-04-14T01:37:02.808Z (3 months ago)
- Topics: fenicsx, ipyparallel, mpi, mpi4py, python
- Language: Jupyter Notebook
- Homepage: https://scientificcomputing.github.io/mpi-tutorial/
- Size: 151 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Tutorial for MPI
Welcome to this tutorial (in development)
# Contributing guidelines
1. If you have maintainer privileges, you can skip this step, otherwise make a [fork](https://github.com/scientificcomputing/mpi-tutorial/fork) of this repository.
2. Clone the repository (or fork) and create a new branch with `git checkout -b github-username/feature-description`
3. Create a compatible working environment, for instance by building the project docker-image.
```bash
docker build -t local_docker_file -f docker/Dockerfile .
docker run -ti -v $(pwd):/root/shared -w /root/shared --name=tutorialmpi local_docker_file
```
You can also use conda to build your environment
```bash
conda env update --file environment.yml --name name-of-your-env
```
4. Create an `.ipynb` in the [notebooks](./notebooks/) folder, or modify the existing notebooks. If a new notebook has been created, add it to the appropriate section of [_toc.yml](_toc.yml). You can use the [template-notebook](./notebooks/template.ipynb) as a starting point.
5. Make sure the webpage builds correctly by calling `jupyter book build -W .` from the root of the repository. You can inspect the webpage locally by opening [_build/html/index.html](_build/html/index.html) with the web-browser of your choice.
6. Make a [pull-request](https://github.com/scientificcomputing/mpi-tutorial/compare) to the main branch of this repo.
7. Make sure that the workflow [Build documentation](https://github.com/scientificcomputing/mpi-tutorial/actions/workflows/build_docs.yml) passes.