Skip to content

Commit

Permalink
Merge upstream changes
Browse files Browse the repository at this point in the history
  • Loading branch information
thivinanandh committed Jul 9, 2024
2 parents a9efb29 + 0fdaf01 commit dccbb6d
Show file tree
Hide file tree
Showing 54 changed files with 2,054 additions and 1,291 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
![Python Versions](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11-blue)

[![status](https://joss.theoj.org/papers/173453d08813f66a718f583502351747/status.svg)](https://joss.theoj.org/papers/173453d08813f66a718f583502351747)


<br />
Expand All @@ -27,10 +27,10 @@
</p>
</div>

A robust tensor-based deep learning framework for solving PDE's using hp-Variational Physics-Informed Neural Networks (hp-VPINNs). The framework is based on the work by [FastVPINNs Paper](https://arxiv.org/abs/2404.12063).
A robust tensor-based deep learning framework for solving partial differential equations using hp-Variational Physics-Informed Neural Networks (hp-VPINNs). The framework is based on the methodology presented in the [FastVPINNs Paper](https://arxiv.org/abs/2404.12063).


*This library is an highly optimised version of the the initial implementation of hp-VPINNs by [kharazmi](https://github.com/ehsankharazmi/hp-VPINNs). Ref [hp-VPINNs Paper](https://arxiv.org/abs/2003.05385).*
*This library is a highly optimised version of the the initial implementation of hp-VPINNs by [Kharazmi et al.](https://github.com/ehsankharazmi/hp-VPINNs). Refer the [hp-VPINNs Paper](https://arxiv.org/abs/2003.05385).*

## Authors 👨‍💻
---
Expand All @@ -42,7 +42,7 @@ STARS Lab, Department of Computational and Data Sciences, Indian Institute of Sc
## Installation 🛠️
---

The build of the code is currently tested on Python versions (3.8, 3.9, 3.10, 3.11), on OS Ubuntu 20.04 and Ubuntu 22.04, Macos-latest and Windows-latest (refer compatibility build [Compatability check](https://github.com/cmgcds/fastvpinns/actions/workflows/compatibility-tests.yml)).
The build of the code is currently tested on Python versions (3.8, 3.9, 3.10, 3.11), on OS Ubuntu 20.04 and Ubuntu 22.04, MacOS-latest and Windows-latest (refer compatibility build [Compatability check](https://github.com/cmgcds/fastvpinns/actions/workflows/compatibility-tests.yml)).

You can install the package using pip as follows:

Expand Down Expand Up @@ -113,9 +113,9 @@ Note : Supporting functions which define the actual solution and boundary condit

## Contributing 🤝
---
This code is currently maintained by the Authors as mentioned in the section above. We welcome contributions from the community. please refer to the [documentation](https://cmgcds.github.io/fastvpinns/) for guidelines on contributing to the project.
This code is currently maintained by the authors as mentioned in the section above. We welcome contributions from the community. Please refer to the [documentation](https://cmgcds.github.io/fastvpinns/) for guidelines on contributing to the project.

## License 📑
---

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
8 changes: 4 additions & 4 deletions docs/_rst/_installation.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Installation
============

The build of the code is currently tested on Python 3.8, 3.9, 3.10 and 3.11. The code is CI tested on environments provided by Github Actions such as `ubuntu-20.04`, `ubuntu-latest`, `macos-latest`, `windows-latest`,
The build of the code is currently tested on Python 3.8, 3.9, 3.10 and 3.11. The code is CI tested on environments provided by Github Actions such as `Ubuntu-20.04`, `Ubuntu-latest`, `MacOS-latest`, `Windows-latest`,
refer to `Compatibility-CI <https://github.com/cmgcds/fastvpinns/actions/workflows/integration-tests.yml>`_ page for more details.

Setting up an Virtual Environment
_________________________________
Setting up a Virtual Environment
________________________________

It is recommended to create a virtual environment to install the package. You can create a virtual environment using the following command:

Expand All @@ -31,7 +31,7 @@ You can simply install the package using pip as follows:
pip install fastvpinns
On ubuntu/mac systems with libGL issues caused due to matplotlib or gmsh, please run the following command to install the required dependencies.
On Ubuntu/Mac systems with libGL issues caused due to matplotlib or gmsh, please run the following command to install the required dependencies.

.. code-block:: bash
Expand Down
13 changes: 11 additions & 2 deletions docs/_rst/_team.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
Team & Fundings
===============

FastVPINNs Team
==============
~~~~~~~~~~~~~~~

FastVPINNs is currently developed by `Thivin Anandh <https://github.com/thivinanandh>`_, `Divij Ghose <https://divijghose.github.io/>`_,
under supervision of `Prof. Sashikumaar Ganesan <http://cds.iisc.ac.in/faculty/sashi/>`_ at `STARS LAB, Indian Institute of Science, Bangalore <https://cmg.cds.iisc.ac.in/>`_.
under the supervision of `Prof. Sashikumaar Ganesan <http://cds.iisc.ac.in/faculty/sashi/>`_ at `STARS LAB, Indian Institute of Science, Bangalore <https://cmg.cds.iisc.ac.in/>`_.

Developers: `Thivin Anandh <https://github.com/thivinanandh>`_, `Divij Ghose <https://divijghose.github.io/>`_, `Prof. Sashikumaar Ganesan <http://cds.iisc.ac.in/faculty/sashi/>`_

Documentation : `Rithika Chidambaram <https://www.linkedin.com/in/rithika-c-328a661b5/>`_

Funding
~~~~~~~

The Authors would like to acknowledge the support of Shell Technology Centre, India for their partial funding, We are thankful to the MHRD Grant No. STARS-1/388 (SPADE)
for partial support.
6 changes: 3 additions & 3 deletions docs/_rst/library/fe2d/fe2d_basis_function.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
fastvpinns.FE.basis\_2d\_QN\_Jacobi module
----------------------------------------------
fastvpinns.FE.basis\_function\_2d
---------------------------------

.. automodule:: fastvpinns.FE.basis_2d_QN_Jacobi
.. automodule:: fastvpinns.FE.basis_function_2d
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit dccbb6d

Please sign in to comment.