Skip to content

Commit fe9506d

Browse files
committed
Merge branch 'main' into update-heateq-example
2 parents 466a49e + bfef194 commit fe9506d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+8888
-4457
lines changed

.all-contributorsrc

Lines changed: 55 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"contributions": [
1717
"code",
1818
"doc",
19-
"infra",
19+
"ideas",
2020
"maintenance",
2121
"projectManagement",
2222
"research"
@@ -29,19 +29,8 @@
2929
"profile": "https://jordibolibar.wordpress.com",
3030
"contributions": [
3131
"doc",
32-
"example",
33-
"ideas"
34-
]
35-
},
36-
{
37-
"login": "fperez",
38-
"name": "Fernando Perez",
39-
"avatar_url": "https://avatars.githubusercontent.com/u/57394?v=4",
40-
"profile": "https://statistics.berkeley.edu/people/fernando-perez",
41-
"contributions": [
4232
"ideas",
43-
"mentoring",
44-
"financial"
33+
"research"
4534
]
4635
},
4736
{
@@ -50,7 +39,10 @@
5039
"avatar_url": "https://avatars.githubusercontent.com/u/42201748?v=4",
5140
"profile": "http://frankschae.github.io",
5241
"contributions": [
53-
"code"
42+
"code",
43+
"doc",
44+
"ideas",
45+
"research"
5446
]
5547
},
5648
{
@@ -59,16 +51,43 @@
5951
"avatar_url": "https://avatars.githubusercontent.com/u/841306?v=4",
6052
"profile": "http://bgroenke.com",
6153
"contributions": [
62-
"code"
54+
"code",
55+
"doc",
56+
"ideas"
6357
]
6458
},
6559
{
66-
"login": "ChrisRackauckas",
67-
"name": "Christopher Rackauckas",
68-
"avatar_url": "https://avatars.githubusercontent.com/u/1814174?v=4",
69-
"profile": "http://www.chrisrackauckas.com",
60+
"login": "avik-pal",
61+
"name": "Avik Pal",
62+
"avatar_url": "https://avatars.githubusercontent.com/u/30564094?v=4",
63+
"profile": "https://avik-pal.github.io",
7064
"contributions": [
71-
"ideas"
65+
"code",
66+
"doc",
67+
"test"
68+
]
69+
},
70+
{
71+
"login": "vboussange",
72+
"name": "vboussange",
73+
"avatar_url": "https://avatars.githubusercontent.com/u/28376122?v=4",
74+
"profile": "https://vboussange.github.io",
75+
"contributions": [
76+
"doc",
77+
"ideas",
78+
"research"
79+
]
80+
},
81+
{
82+
"login": "heimbach",
83+
"name": "Patrick Heimbach",
84+
"avatar_url": "https://avatars.githubusercontent.com/u/5150349?v=4",
85+
"profile": "https://github.com/heimbach",
86+
"contributions": [
87+
"doc",
88+
"ideas",
89+
"mentoring",
90+
"research"
7291
]
7392
},
7493
{
@@ -77,28 +96,34 @@
7796
"avatar_url": "https://avatars.githubusercontent.com/u/12737775?v=4",
7897
"profile": "https://github.com/gileshooker",
7998
"contributions": [
99+
"doc",
80100
"ideas",
81101
"mentoring"
82102
]
83103
},
84104
{
85-
"login": "heimbach",
86-
"name": "Patrick Heimbach",
87-
"avatar_url": "https://avatars.githubusercontent.com/u/5150349?v=4",
88-
"profile": "https://github.com/heimbach",
105+
"login": "fperez",
106+
"name": "Fernando Pérez",
107+
"avatar_url": "https://avatars.githubusercontent.com/u/57394?v=4",
108+
"profile": "https://statistics.berkeley.edu/people/fernando-perez",
89109
"contributions": [
110+
"doc",
111+
"financial",
90112
"ideas",
91-
"doc"
113+
"mentoring"
92114
]
93115
},
94116
{
95-
"login": "vboussange",
96-
"name": "vboussange",
97-
"avatar_url": "https://avatars.githubusercontent.com/u/28376122?v=4",
98-
"profile": "https://vboussange.github.io",
117+
"login": "ChrisRackauckas",
118+
"name": "Christopher Rackauckas",
119+
"avatar_url": "https://avatars.githubusercontent.com/u/1814174?v=4",
120+
"profile": "http://www.chrisrackauckas.com",
99121
"contributions": [
122+
"code",
100123
"doc",
101-
"ideas"
124+
"financial",
125+
"ideas",
126+
"mentoring"
102127
]
103128
}
104129
]

.github/workflows/CI.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: CI
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
push:
7+
branches:
8+
- main
9+
10+
concurrency:
11+
# Skip intermediate builds: always.
12+
# Cancel intermediate builds: only if it is a pull request build.
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
15+
16+
jobs:
17+
test:
18+
if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
19+
runs-on: ${{ matrix.os }}
20+
strategy:
21+
fail-fast: false
22+
matrix:
23+
version:
24+
- "1"
25+
os:
26+
- ubuntu-latest
27+
- macos-latest
28+
- windows-latest
29+
steps:
30+
- uses: actions/checkout@v4
31+
- uses: julia-actions/setup-julia@v2
32+
with:
33+
version: ${{ matrix.version }}
34+
- uses: actions/cache@v4
35+
env:
36+
cache-name: cache-artifacts
37+
with:
38+
path: ~/.julia/artifacts
39+
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
40+
restore-keys: |
41+
${{ runner.os }}-test-${{ env.cache-name }}-
42+
${{ runner.os }}-test-
43+
${{ runner.os }}-
44+
- name: Run all the scripts
45+
run: julia --color=yes --project=code -e 'using Pkg; Pkg.instantiate(); include("code/run_all_scripts.jl")'

.github/workflows/latex.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,13 @@ jobs:
2020
- name: Set up Git repository
2121
uses: actions/checkout@v3
2222
- name: Compile LaTeX document
23-
uses: xu-cheng/latex-action@v2
23+
uses: xu-cheng/latex-action@v3
2424
with:
2525
root_file: main.tex
2626
working_directory: ./tex
27+
continue_on_error: true
28+
texlive_version: 2023
29+
# args: -f
2730
- name: Upload PDF file
2831
uses: actions/upload-artifact@v3
2932
with:

README.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,25 @@
22
![example workflow](https://github.com/ODINN-SciML/DiffEqSensitivity-Review/actions/workflows/biblatex.yml/badge.svg)
33
[![All Contributors](https://img.shields.io/github/all-contributors/ODINN-SciML/DiffEqSensitivity-Review?color=ee8449&style=flat-square)](#contributors)
44

5-
# A Review of Sensitivity Methods for Differential Equations
5+
# Differentiable programming for Differential equations: a review
6+
7+
### ⚠️ New preprint available! 📖 ⚠️
8+
9+
The review paper is now available as a preprint on arXiv: https://arxiv.org/abs/2406.09699
10+
11+
If you want to cite this work, please use this BibTex citation:
12+
```
13+
@misc{sapienza2024differentiable,
14+
title={Differentiable Programming for Differential Equations: A Review},
15+
author={Facundo Sapienza and Jordi Bolibar and Frank Schäfer and Brian Groenke and Avik Pal and Victor Boussange and Patrick Heimbach and Giles Hooker and Fernando Pérez and Per-Olof Persson and Christopher Rackauckas},
16+
year={2024},
17+
eprint={2406.09699},
18+
archivePrefix={arXiv},
19+
primaryClass={id='math.NA' full_name='Numerical Analysis' is_active=True alt_name='cs.NA' in_archive='math' is_general=False description='Numerical algorithms for problems in analysis and algebra, scientific computation'}
20+
}
21+
```
22+
23+
---
624

725
This respository contains all the text, code and figures used for the review paper about sentitivity methods for differential equations. This topic received different names in different communities, but the core problem is quite simple. Given a system of differential equations
826
```math
@@ -33,17 +51,18 @@ The goal of this review is to revisit all this methods and compare them.
3351
<table>
3452
<tbody>
3553
<tr>
36-
<td align="center" valign="top" width="14.28%"><a href="http://facusapienza.org"><img src="https://avatars.githubusercontent.com/u/39526081?v=4?s=100" width="100px;" alt="Facundo Sapienza"/><br /><sub><b>Facundo Sapienza</b></sub></a><br /><a href="#code-facusapienza21" title="Code">💻</a> <a href="#doc-facusapienza21" title="Documentation">📖</a> <a href="#infra-facusapienza21" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-facusapienza21" title="Maintenance">🚧</a> <a href="#projectManagement-facusapienza21" title="Project Management">📆</a> <a href="#research-facusapienza21" title="Research">🔬</a></td>
37-
<td align="center" valign="top" width="14.28%"><a href="https://jordibolibar.wordpress.com"><img src="https://avatars.githubusercontent.com/u/2025815?v=4?s=100" width="100px;" alt="Jordi Bolibar"/><br /><sub><b>Jordi Bolibar</b></sub></a><br /><a href="#doc-JordiBolibar" title="Documentation">📖</a> <a href="#example-JordiBolibar" title="Examples">💡</a> <a href="#ideas-JordiBolibar" title="Ideas, Planning, & Feedback">🤔</a></td>
38-
<td align="center" valign="top" width="14.28%"><a href="https://statistics.berkeley.edu/people/fernando-perez"><img src="https://avatars.githubusercontent.com/u/57394?v=4?s=100" width="100px;" alt="Fernando Perez"/><br /><sub><b>Fernando Perez</b></sub></a><br /><a href="#ideas-fperez" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-fperez" title="Mentoring">🧑‍🏫</a> <a href="#financial-fperez" title="Financial">💵</a></td>
39-
<td align="center" valign="top" width="14.28%"><a href="http://frankschae.github.io"><img src="https://avatars.githubusercontent.com/u/42201748?v=4?s=100" width="100px;" alt="frankschae"/><br /><sub><b>frankschae</b></sub></a><br /><a href="#code-frankschae" title="Code">💻</a></td>
40-
<td align="center" valign="top" width="14.28%"><a href="http://bgroenke.com"><img src="https://avatars.githubusercontent.com/u/841306?v=4?s=100" width="100px;" alt="Brian Groenke"/><br /><sub><b>Brian Groenke</b></sub></a><br /><a href="#code-bgroenks96" title="Code">💻</a></td>
41-
<td align="center" valign="top" width="14.28%"><a href="http://www.chrisrackauckas.com"><img src="https://avatars.githubusercontent.com/u/1814174?v=4?s=100" width="100px;" alt="Christopher Rackauckas"/><br /><sub><b>Christopher Rackauckas</b></sub></a><br /><a href="#ideas-ChrisRackauckas" title="Ideas, Planning, & Feedback">🤔</a></td>
42-
<td align="center" valign="top" width="14.28%"><a href="https://github.com/gileshooker"><img src="https://avatars.githubusercontent.com/u/12737775?v=4?s=100" width="100px;" alt="gileshooker"/><br /><sub><b>gileshooker</b></sub></a><br /><a href="#ideas-gileshooker" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-gileshooker" title="Mentoring">🧑‍🏫</a></td>
54+
<td align="center" valign="top" width="14.28%"><a href="http://facusapienza.org"><img src="https://avatars.githubusercontent.com/u/39526081?v=4?s=100" width="100px;" alt="Facundo Sapienza"/><br /><sub><b>Facundo Sapienza</b></sub></a><br /><a href="#code-facusapienza21" title="Code">💻</a> <a href="#doc-facusapienza21" title="Documentation">📖</a> <a href="#ideas-facusapienza21" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-facusapienza21" title="Maintenance">🚧</a> <a href="#projectManagement-facusapienza21" title="Project Management">📆</a> <a href="#research-facusapienza21" title="Research">🔬</a></td>
55+
<td align="center" valign="top" width="14.28%"><a href="https://jordibolibar.wordpress.com"><img src="https://avatars.githubusercontent.com/u/2025815?v=4?s=100" width="100px;" alt="Jordi Bolibar"/><br /><sub><b>Jordi Bolibar</b></sub></a><br /><a href="#doc-JordiBolibar" title="Documentation">📖</a> <a href="#ideas-JordiBolibar" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-JordiBolibar" title="Research">🔬</a></td>
56+
<td align="center" valign="top" width="14.28%"><a href="http://frankschae.github.io"><img src="https://avatars.githubusercontent.com/u/42201748?v=4?s=100" width="100px;" alt="frankschae"/><br /><sub><b>frankschae</b></sub></a><br /><a href="#code-frankschae" title="Code">💻</a> <a href="#doc-frankschae" title="Documentation">📖</a> <a href="#ideas-frankschae" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-frankschae" title="Research">🔬</a></td>
57+
<td align="center" valign="top" width="14.28%"><a href="http://bgroenke.com"><img src="https://avatars.githubusercontent.com/u/841306?v=4?s=100" width="100px;" alt="Brian Groenke"/><br /><sub><b>Brian Groenke</b></sub></a><br /><a href="#code-bgroenks96" title="Code">💻</a> <a href="#doc-bgroenks96" title="Documentation">📖</a> <a href="#ideas-bgroenks96" title="Ideas, Planning, & Feedback">🤔</a></td>
58+
<td align="center" valign="top" width="14.28%"><a href="https://avik-pal.github.io"><img src="https://avatars.githubusercontent.com/u/30564094?v=4?s=100" width="100px;" alt="Avik Pal"/><br /><sub><b>Avik Pal</b></sub></a><br /><a href="#code-avik-pal" title="Code">💻</a> <a href="#doc-avik-pal" title="Documentation">📖</a> <a href="#test-avik-pal" title="Tests">⚠️</a></td>
59+
<td align="center" valign="top" width="14.28%"><a href="https://vboussange.github.io"><img src="https://avatars.githubusercontent.com/u/28376122?v=4?s=100" width="100px;" alt="vboussange"/><br /><sub><b>vboussange</b></sub></a><br /><a href="#doc-vboussange" title="Documentation">📖</a> <a href="#ideas-vboussange" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-vboussange" title="Research">🔬</a></td>
60+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/heimbach"><img src="https://avatars.githubusercontent.com/u/5150349?v=4?s=100" width="100px;" alt="Patrick Heimbach"/><br /><sub><b>Patrick Heimbach</b></sub></a><br /><a href="#doc-heimbach" title="Documentation">📖</a> <a href="#ideas-heimbach" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-heimbach" title="Mentoring">🧑‍🏫</a> <a href="#research-heimbach" title="Research">🔬</a></td>
4361
</tr>
4462
<tr>
45-
<td align="center" valign="top" width="14.28%"><a href="https://github.com/heimbach"><img src="https://avatars.githubusercontent.com/u/5150349?v=4?s=100" width="100px;" alt="Patrick Heimbach"/><br /><sub><b>Patrick Heimbach</b></sub></a><br /><a href="#ideas-heimbach" title="Ideas, Planning, & Feedback">🤔</a> <a href="#doc-heimbach" title="Documentation">📖</a></td>
46-
<td align="center" valign="top" width="14.28%"><a href="https://vboussange.github.io"><img src="https://avatars.githubusercontent.com/u/28376122?v=4?s=100" width="100px;" alt="vboussange"/><br /><sub><b>vboussange</b></sub></a><br /><a href="#doc-vboussange" title="Documentation">📖</a> <a href="#ideas-vboussange" title="Ideas, Planning, & Feedback">🤔</a></td>
63+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/gileshooker"><img src="https://avatars.githubusercontent.com/u/12737775?v=4?s=100" width="100px;" alt="gileshooker"/><br /><sub><b>gileshooker</b></sub></a><br /><a href="#doc-gileshooker" title="Documentation">📖</a> <a href="#ideas-gileshooker" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-gileshooker" title="Mentoring">🧑‍🏫</a></td>
64+
<td align="center" valign="top" width="14.28%"><a href="https://statistics.berkeley.edu/people/fernando-perez"><img src="https://avatars.githubusercontent.com/u/57394?v=4?s=100" width="100px;" alt="Fernando Pérez"/><br /><sub><b>Fernando Pérez</b></sub></a><br /><a href="#doc-fperez" title="Documentation">📖</a> <a href="#financial-fperez" title="Financial">💵</a> <a href="#ideas-fperez" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-fperez" title="Mentoring">🧑‍🏫</a></td>
65+
<td align="center" valign="top" width="14.28%"><a href="http://www.chrisrackauckas.com"><img src="https://avatars.githubusercontent.com/u/1814174?v=4?s=100" width="100px;" alt="Christopher Rackauckas"/><br /><sub><b>Christopher Rackauckas</b></sub></a><br /><a href="#code-ChrisRackauckas" title="Code">💻</a> <a href="#doc-ChrisRackauckas" title="Documentation">📖</a> <a href="#financial-ChrisRackauckas" title="Financial">💵</a> <a href="#ideas-ChrisRackauckas" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-ChrisRackauckas" title="Mentoring">🧑‍🏫</a></td>
4766
</tr>
4867
</tbody>
4968
</table>
@@ -89,15 +108,8 @@ We are driving by learning and undersranding and the original authors of this re
89108
We encourage contributors to participate in this project! If you are interested in contributing, there are many ways in which you can help build this:
90109
- :collision: **Report bugs in the code.** You can report problems with the code by oppening issues under the `Issues` tab in this repository. Please explain the problem you encounter and try to give a complete description of it so we can follow up on that.
91110
- :books: **Suggest new bibliography.** If you are aware of references that may be useful to explore and expand this review, you can report it by creating an `Issue` in this repository, with the title of the issue being the title of the paper and adding the label `paper` to the issue.
92-
- :deciduous_tree: **Add contents.** You are more than welcome to directly contribute to this repository and add contents to it. In order to do so, you can directly make a Pull Request to this repository and we will review the changes before being accepted. If you want to get more and more involved in the project.
93111
- :bulb: **Request new features and explanations.** If there is an important topic or example that you feel falls under the scope of this review and you would like us to include it, please request it! We are looking for new insights into what the community wants to learn.
94112

95-
### Make a Pull Request! :octocat:
96-
97-
The easiest way to contribute by adding code and/or text is to [create a new fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of this repository and then [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) to the main
98-
repository. You can add changes and explore new things in your own fork of this repository and then make a pull request to the repository asking to include some of the contents in the repository. Pull requests are the best way of merging different versions of a repository since it allows to open a conversation about the new implemented changes and solve potential merge conflicts at the same time.
99-
100-
**working from Overleaf?** You can create a Overleaf project that is synchronized with a GitHub repository (see [here](https://www.overleaf.com/learn/how-to/Git_Integration_and_GitHub_Synchronization) for more information). This allows you to do edits on the text file directly from Overleaf and then push your changes directly to your fork, from where you can make a pull request to the main repository.
101113

102114
## Contact
103115

0 commit comments

Comments
 (0)