Skip to content

Commit

Permalink
Add paper (#6)
Browse files Browse the repository at this point in the history
* Add documentation

* Change heading structure
  • Loading branch information
Ceyron authored Nov 5, 2024
1 parent 0540682 commit 4cc1f53
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 9 deletions.
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
<a href="#background">Background</a> •
<a href="#features">Features</a> •
<a href="#boundary-conditions">Boundary Conditions</a> •
<!-- <a href="#constructors">Constructors</a> • -->
<a href="#acknowledgements">Acknowledgements</a>
<a href="#related-work">Related</a> •
<a href="#citation">Citation</a>
</p>

<p align="center">
Expand Down Expand Up @@ -157,9 +157,7 @@ Dirichlet boundaries fully eliminate degrees of freedom on the boundary.
Periodic boundaries only keep one end of the domain as a degree of freedom (This
package follows the convention that the left boundary is the degree of freedom). Neumann boundaries keep both ends as degrees of freedom.

## Acknowledgements

### Related Work
## Related Work

Similar packages that provide a collection of emulator architectures are
[PDEBench](https://github.com/pdebench/PDEBench) and
Expand All @@ -168,15 +166,33 @@ Neural Networks and Neural Operators, there are also
[DeepXDE](https://github.com/lululxvi/deepxde) and [NVIDIA
Modulus](https://developer.nvidia.com/modulus).

### Citation
## Citation

This package was developed as part of the [APEBench paper
(arxiv.org/abs/2411.00180)](https://arxiv.org/abs/2411.00180) (accepted at
Neurips 2024). If you find it useful for your research, please consider citing
it:

```bibtex
@article{koehler2024apebench,
title={{APEBench}: A Benchmark for Autoregressive Neural Emulators of {PDE}s},
author={Felix Koehler and Simon Niedermayr and R{\"}udiger Westermann and Nils Thuerey},
journal={Advances in Neural Information Processing Systems (NeurIPS)},
volume={38},
year={2024}
}
```

(Feel free to also give the project a star on GitHub if you like it.)

This package was developed as part of the `APEBench paper` (accepted at Neurips 2024), we will soon add the citation here.
[Here](https://github.com/tum-pbs/apebench) you can find the APEBench benchmark
suite.

### Funding
## Funding

The main author (Felix Koehler) is a PhD student in the group of [Prof. Thuerey at TUM](https://ge.in.tum.de/) and his research is funded by the [Munich Center for Machine Learning](https://mcml.ai/).

### License
## License

MIT, see [here](LICENSE.txt)

Expand Down
21 changes: 21 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,27 @@ for epoch in tqdm(range(100)):
* Composability
* Tools to count parameters and assess receptive fields

## Citation

This package was developed as part of the [APEBench paper
(arxiv.org/abs/2411.00180)](https://arxiv.org/abs/2411.00180) (accepted at
Neurips 2024). If you find it useful for your research, please consider citing
it:

```bibtex
@article{koehler2024apebench,
title={{APEBench}: A Benchmark for Autoregressive Neural Emulators of {PDE}s},
author={Felix Koehler and Simon Niedermayr and R{\"}udiger Westermann and Nils Thuerey},
journal={Advances in Neural Information Processing Systems (NeurIPS)},
volume={38},
year={2024}
}
```

(Feel free to also give the project a star on GitHub if you like it.)

[Here](https://github.com/tum-pbs/apebench) you can find the APEBench benchmark
suite.

## License

Expand Down

0 comments on commit 4cc1f53

Please sign in to comment.