https://github.com/gridap/tutorials
Start solving PDEs in Julia with Gridap.jl
https://github.com/gridap/tutorials
gridap julia pdes tutorials
Last synced: 18 days ago
JSON representation
Start solving PDEs in Julia with Gridap.jl
- Host: GitHub
- URL: https://github.com/gridap/tutorials
- Owner: gridap
- License: mit
- Created: 2019-08-08T16:15:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-09T11:36:21.000Z (about 2 months ago)
- Last Synced: 2025-03-30T22:12:04.296Z (25 days ago)
- Topics: gridap, julia, pdes, tutorials
- Language: Julia
- Homepage:
- Size: 55.2 MB
- Stars: 130
- Watchers: 10
- Forks: 45
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Gridap tutorials 
*Start solving PDEs in Julia*
| **Documentation** |
|:------------ |
| [](https://gridap.github.io/Tutorials/stable) [](https://gridap.github.io/Tutorials/dev) |
|**Build Status** |
| [](https://github.com/gridap/Tutorials/actions?query=workflow%3ACI) |
| **Community** |
| [](https://gitter.im/Gridap-jl/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| **Citation** |
| [](https://doi.org/10.21105/joss.02520) |
## What
This repo contains a set of tutorials to learn how to solve partial differential equations (PDEs) in Julia with the Gridap ecosystem of packages. At the root of this ecosystem is the [Gridap.jl](https://github.com/gridap/Gridap.jl) library. The initial tutorials illustrate the usage of the tools in [Gridap.jl](https://github.com/gridap/Gridap.jl), and these are the tutorials new users should focus on.
Within the Gridap ecosystem there are several [satellite/plugin packages](https://github.com/gridap/Gridap.jl#plugins) that serve different purposes. Some of the tutorials focus on the combined usage of [Gridap.jl](https://github.com/gridap/Gridap.jl) and the plugin packages. For example, [this tutorial](https://gridap.github.io/Tutorials/dev/pages/t016_poisson_distributed/) illustrates the usage of [GridapDistributed.jl](https://github.com/gridap/GridapDistributed.jl) for the solution of PDEs on parallel distributed-memory supercomputers.
The tutorials are available in two formats:
- As jupyter notebooks, allowing an interactive learning experience. **This is the recommended way to follow the tutorials**
- As HTML pages, allowing a rapid access into the material without the need of any setup.
## How
Visit one of the following pages, depending of your needs, and start enjoying!
- [**STABLE**](https://gridap.github.io/Tutorials/stable) — **Tutorials for the most recently tagged version of Gridap.jl.**
- [**DEVEL**](https://gridap.github.io/Tutorials/dev) — *Tutorials for the in-development version of Gridap.jl.*
## Generating tutorials locally
Note: **only if you intend to contribute to the tutorials as an advanced user/developer**
If you want to contribute to the tutorials, e.g., to make changes in their sources, you might need to generate (render) them locally to see whether the changes in the sources produce the expected outcome in the output (i.e., Jupyter notebooks + HTML pages). To this end, you have to follow the following instructions once:
```
julia --project=docs # From the Unix shell, located at the root of Tutorials repo
develop . # From the Julia package manager prompt
instantiate # ""
build # ""
exit() # From the Julia REPL
```
and then, each time that you perform a change on the tutorial sources, you have to execute the following command:
```
julia --project=docs docs/make.jl # From the Unix shell, located at the root of Tutorials repo
```
to generate the tutorials. The files generated are available at `Tutorials/docs/build/`.
## Gridap community
Join to our [gitter](https://gitter.im/Gridap-jl/community) chat to ask questions and interact with the Gridap community.
## How to cite Gridap
In order to give credit to the `Gridap` contributors, we simply ask you to cite the reference below in any publication in which you have made use of `Gridap` packages:
```
@article{Badia2020,
doi = {10.21105/joss.02520},
url = {https://doi.org/10.21105/joss.02520},
year = {2020},
publisher = {The Open Journal},
volume = {5},
number = {52},
pages = {2520},
author = {Santiago Badia and Francesc Verdugo},
title = {Gridap: An extensible Finite Element toolbox in Julia},
journal = {Journal of Open Source Software}
}
```
## Contact
Please, contact the project administrators, [Santiago Badia](mailto:[email protected]) and [Francesc Verdugo](mailto:[email protected]), for further questions about licenses and terms of use.