Metadata-Version: 2.5
Name: phlower
Version: 0.4.0
Summary: This is a Python package which helps you handle GNN especially for physics problems.
Author: RICOS Co. Ltd.
Maintainer-email: Riku Sakamoto <sakamoto@ricos.co.jp>
License: Copyright [2023] [RICOS]
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
            http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
License-File: LICENSE
Keywords: deep-learning,graph-neural-networks,machine-learning,physics-simulation,pytorch,scientific-computing
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: <4.0,>=3.11
Requires-Dist: dagstream>=0.1.5
Requires-Dist: einops>=0.8.0
Requires-Dist: pandas>=2.2.2
Requires-Dist: phlower-tensor>=0.1.0
Requires-Dist: pipe<3,>=2.2
Requires-Dist: pyamg>=5.3.0
Requires-Dist: pycryptodomex<4,>=3.20.0
Requires-Dist: pydantic<3,>=2.7.0
Requires-Dist: pyvista<1,>=0.43.10
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: scikit-learn<2,>=1.5.0
Requires-Dist: scipy<2,>=1.13.0
Requires-Dist: sympy>=1.13.1
Requires-Dist: tqdm>=4.66.4
Provides-Extra: cpu
Requires-Dist: torch>=2.5.1; extra == 'cpu'
Requires-Dist: torchvision>=0.20.1; extra == 'cpu'
Provides-Extra: cu118
Requires-Dist: cupy-cuda11x>=13.6.0; extra == 'cu118'
Requires-Dist: torch>=2.5.1; extra == 'cu118'
Requires-Dist: torchvision>=0.20.1; extra == 'cu118'
Provides-Extra: cu124
Requires-Dist: cupy-cuda12x>=14.0.1; extra == 'cu124'
Requires-Dist: torch>=2.5.1; extra == 'cu124'
Requires-Dist: torchvision>=0.20.1; extra == 'cu124'
Description-Content-Type: text/markdown

# Phlower

![PyPI - Implementation](https://img.shields.io/pypi/implementation/phlower)
![PyPI - Version](https://img.shields.io/pypi/pyversions/phlower)

![](docs/source/_static/logo.png)


__Phlower__ is a deep learning framework based on PyTorch especially for physical phenomenon such as fluid dynamics.

For more details, please refer to user manual below.

- [User Manual](https://ricosjp.github.io/phlower/)


## Key Features


Tutorials are prepared for key features !

1. [Extended Tensor object which enables you to handle physics dimention](https://ricosjp.github.io/phlower/tutorials/basic_usages/01_phlower_tensor_basic.html)
2. [Model definition by yaml file](https://ricosjp.github.io/phlower/tutorials/basic_usages/02_model_definition_by_yaml_file.html)
3. [High Level API for scaling, training and predicion](https://ricosjp.github.io/phlower/tutorials/basic_usages/03_high_level_api_for_scaling_training_and_prediction.html)



## Installation

**Phlower** is registered at [PyPI](https://pypi.org/project/phlower/).

If you have already installed PyTorch, you can install phlower using pip. Python 3.10 or newer is supported.

```
pip install phlower
```

If you have not installed PyTorch yet, please follow the instructions on the official PyTorch website: [https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/).
Or, you can install phlower along with PyTorch by specifying the appropriate extra keyword. For example, to install phlower with CPU support only, use the following command:

```
pip install phlower[cpu]
```

`cu118` and `cu124` are also available for CUDA 11.8 and CUDA 12.4, respectively.


## License

This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)


## Development

This github repository is mirrored from the internal GitLab server of RICOS Corporation.
This is because some tests need to use GPU resources provided by RICOS.
However, the development is basically open to public and contributions are welcome.


## Publication

We have published a conference paper about Phlower.

> **Phlower: A Deep Learning Framework Supporting PyTorch Tensors with Physical Dimensions**  
> Riku Sakamoto  
> *Proceedings of the SciPy Conference*, 2025  
> DOI: https://doi.org/10.25080/vwty6796

