Skip to main content

Peano 4

Peano is a framework for solvers operating on dynamically adaptive Cartesian meshes. It is the base for a couple of further engines or toolboxes for different application areas, while the framework is really only about the mesh management, data storage, distribution and mesh traversal. The latest version of Peano is the 4th generation of the code. It is completely free.

Codes built with Peano

Download

Peano and its extensions are hosted on the gitlab of the LRZ. We do not provide any regular snapshots, but you can always clone the latest version directly from the git:

git clone -b p4 https://gitlab.lrz.de/hpcsoftware/Peano.git

We are happy to give interested users write permissions to the repository such that they can merge their contributions into the public code base.

License

Peano has a BSD-like license. Clone the code and study the file COPY in the root folder. BSD-like means that you can basically do anything with the code including any commercial use, even if you directly inline code (what you have do if you use Peano’s templates). In return for all the freedom, we’d appreciate if you cited the code when you use it.

Documentation

Peano realises a relatively strict document-in-the-code paradigm. All the documentation (including tutorials, installation instructions, FAQs, description of the numerics, …) can be generated from the code through doxygen. The resulting documentation is generated after each push and can be found at

https://hpcsoftware.pages.gitlab.lrz.de/Peano/

If you want to generate the documentation locally, clone the repository and type in

doxygen documentation/Doxyfile

to create the documentation website on your machine.

Citing Peano

While Peano is a plain C++ code, most colleagues use it through its Python API. The API generates a lot of glue code plus a makefile such that Peano can run as stand-alone without any Python dependencies. It also generates a Readme file which clarifies which subcomponents of Peano you have used, where you find information about the underlying algorithmic concepts, and what to cite in this context. The Readme should be your first choice when you search for literature about the software.

If you search for a generic overview paper which describes the fundamental design principles and ideas and provides a first overview, please read the ACM TOMS paper

@article{Weinzierl:2019:Peano,
  author = 	 {T. Weinzierl},
  title = 	 {The Peano software---parallel, automaton-based, dynamically adaptive grid traversals},
  journal = 	 {ACM Transactions on Mathematical Software},
  year = 	 {2019},
  volume = 	 {45},
  number = 	 {2},
  pages = 	 {14}
}
  

@tobiasweinzierl.bsky.social

  • If you intend to come to Durham for the HPC Days, please do register. Registration closes 21 May: https://www.durham.ac.uk/research/institutes-and-centres/data-science/events-/durham---hpc-days/ And then, our sponsor of the day: #OCF has provided some of our systems at Durham, so we are happy to have them back as vendor participant.
  • We are very proud to host a SYCL and an AMD GPU programming tutorial at the HPC Days. Don't miss the Monday though with more AI/ML-focused sessions: There is a tutorial on SmartSim and there is a tutorial on FTorch: https://durham.readthedocs.io/en/latest/hpcdays/tutorials.html#iccs-ftorch
  • Our sponsor of the day is VAST. VAST have supported us massively last year, and it is great to have them back at the HPC Days this year. There will be an industry session on Wednesday evening, so you can chat with them: https://durham.readthedocs.io/en/latest/hpcdays/index.html
  • Please note that we have a series of interesting tutorials for the HPC Days: https://durham.readthedocs.io/en/latest/hpcdays/index.html They cover a vast range. Further to that, first information on our social are now online. There's more details to come ...
  • Our sponsor of the day: DDN is one of the companies that are supporting the Durham HPC Days this year, but also have done so in previous ones. They are the driving force behind the Lustre User Group UK which is part of the HPC Day's Tuesday agenda: https://durham.readthedocs.io/en/latest/hpcdays/index.html