Skip to main content

PINN solver implemented in Pytorch

Project description

remin: Residual Minimizer - Physics Informed Neural Networks

License Python Version PyTorch Version

remin is a Python module that provides a framework for developing Physics Informed Neural Networks (PINNs) using PyTorch. This module integrates PyTorch for model creation and training, Latin-Hypercube sampling for geometry creation, and also includes a small, user-friendly module for creating geometries.

Key Features

  • Implementation of Physics Informed Neural Networks (PINNs) using PyTorch.
  • Support for creating geometries using Latin-Hypercube sampling.
  • Intuitive module for defining and creating complex geometries.
  • Command-line interface (CLI) for simultaneous training of multiple models.

Installation

Prerequisites

Before using remin, you will need to install the following packages:

  • PyTorch (version 2.0.0 or later)
  • NumPy
  • pyDOE (version 0.3.8 or later)

You can install all the requirements using pip, the Python package installer. To install PyTorch, run the following command or follow the instructions on their website to install with GPU support:

pip install torch>=2.0.0

To install NumPy, run the following command:

pip install numpy

To install pyDOE, run the following command:

pip install pyDOE>=0.3.8

Alternatively, you can install these packages using conda or any other package manager of your choice.

Once you have installed these packages, remin can be installed using pip(PyPi):

pip install remin

Usage

To use remin in your Python project, import the necessary modules as follows:

import remin.geometry as rd
import remin.func as rf
import remin.solver.residual_loss as rl
from remin.solver import Solver, make_trainer
from remin.residual import Residual, make_loader

Will be extended in future.


Contributing

If you want to contribute to remin, feel free to submit a pull request or open an issue on GitHub.

License

This project is licensed under the MIT License.

Contact

For any questions, suggestions, or feedback, please feel free to contact the maintainer at [salih.tasdelen@metu.edu.tr].

Thank you for using remin!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

remin-0.2.7.tar.gz (908.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

remin-0.2.7-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file remin-0.2.7.tar.gz.

File metadata

  • Download URL: remin-0.2.7.tar.gz
  • Upload date:
  • Size: 908.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for remin-0.2.7.tar.gz
Algorithm Hash digest
SHA256 4b8dc5513ca31c094a0b48530adadf8a5f090ec4af2d0fac74ec70b9663539eb
MD5 4736f5e261357c91ebb0b1662d24e554
BLAKE2b-256 c88b166fa0e35dc8411d2d01bf77f45d65a7412c30cff1c820e21bb738c625cf

See more details on using hashes here.

File details

Details for the file remin-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: remin-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for remin-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9ed0bb22f3c834eea46bb83831faf0e4d76cf7ec9b2ee8973a228b10152cefbf
MD5 c46816adc42deb96137db6cfdd30331c
BLAKE2b-256 ac38981f3a3946d1a33c63d80afa6abb092c7fa93af09e4c4df17eb59c923225

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page