torchphysics 1.1.2

Features

The Goal of this library is to create a basic framework that can be used in many different applications and with different deep learning methods. To this end, TorchPhysics aims at a:

• modular and expandable structure

• easy to understand code and clean documentation

• intuitive and compact way to transfer the mathematical problem into code

• reliable and well tested code basis

Some built-in features are:

• mesh free domain generation. With pre implemented domain types: Point, Interval, Parallelogram, Circle, Triangle and Sphere

• loading external created objects, thanks to a soft dependency on Trimesh and Shapely

• creating complex domains with the boolean operators Union, Cut and Intersection and higher dimensional objects over the Cartesian product

• allowing interdependence of different domains, e.g. creating moving domains

• different point sampling methods for every domain: RandomUniform, Grid, Gaussian, Latin hypercube, Adaptive and some more for specific domains

• different operators to easily define a differential equation

• pre implemented fully connected neural network and easy implementation of additional model structures

• sequentially or parallel evaluation/training of different neural networks

• normalization layers and adaptive weights [5] to speed up the training process

• powerful and versatile training thanks to PyTorch Lightning

  • many options for optimizers and learning rate control

  • monitoring the loss of individual conditions while training

Getting Started

To learn the functionality and usage of TorchPhysics we recommend to have a look at the following sections:

• Tutorial: Understanding the structure of TorchPhysics

• Examples: Different applications with detailed explanations

• Documentation

Installation

TorchPhysics requires the following dependencies to be installed:

• Python >= 3.8

• PyTorch >= 2.0.0

• PyTorch Lightning >= 2.0.0

• Numpy >= 1.20.2, < 2.0

• Matplotlib >= 3.0.0

• Scipy >= 1.6.3

To install TorchPhysics you can run the following code in any Python environment where pip is installed

pip install torchphysics

Or by

git clone https://github.com/Qewton-Labs/torchphysics
cd path_to_torchphysics_folder
pip install .[all]

if you want to modify the code.

About

TorchPhysics was originally developed by Nick Heilenkötter and Tom Freudenberg, as part of a seminar project at the University of Bremen, in cooperation with the Robert Bosch GmbH. Special thanks belong to Felix Hildebrand, Uwe Iben, Daniel Christopher Kreuter and Johannes Mueller, at the Robert Bosch GmbH, for support and supervision while creating this library.

Contribute

If you are missing a feature or detect a bug or unexpected behavior while using this library, feel free to open an issue or a pull request in GitHub or contact the authors. Since we developed the code as a student project during a seminar, we cannot guarantee every feature to work properly. However, we are happy about all contributions since we aim to develop a reliable code basis and extend the library to include other approaches.

Cite TorchPhysics

If TorchPhysics has been helpful for your research, please cite:

@article{TorchPhysics,
    author = {Derick Nganyu Tanyu and Jianfeng Ning and Tom Freudenberg and Nick Heilenkötter and Andreas Rademacher and Uwe Iben and Peter Maass},
    title = {Deep learning methods for partial differential equations and related parameter identification problems},
    journal = {Inverse Problems},
    doi = {10.1088/1361-6420/ace9d4},
    year = {2023},
    publisher = {IOP Publishing},
    volume = {39},
    number = {10},
    pages = {103001}}

License

TorchPhysics uses an Apache License, see the LICENSE file.

Bibliography