Metadata-Version: 2.1
Name: phlower
Version: 0.1.1
Summary: This is a Python package which helps you handle GNN especially for physics problems.
License: Apache-2.0
Author: sakamoto
Author-email: sakamoto@ricos.co.jp
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: dagstream (>=0.1.5,<0.2.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: pipe (>=2.2,<3.0)
Requires-Dist: pycryptodomex (>=3.20.0,<4.0.0)
Requires-Dist: pydantic (>=2.7.0,<3.0.0)
Requires-Dist: pytorch-ignite (>=0.5.0.post2,<0.6.0)
Requires-Dist: pyvista (>=0.43.10,<0.44.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: scikit-learn (>=1.5.0,<2.0.0)
Requires-Dist: scipy (>=1.13.0,<2.0.0)
Requires-Dist: tqdm (>=4.66.4,<5.0.0)
Description-Content-Type: text/markdown

# phlower


__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://github.com/ricosjp/phlower/tutorials/basic_usages/01_phlower_tensor_basic)
2. [Model definition by yaml file](https://github.com/ricosjp/phlower/tutorials/basic_usages/02_model_definition_by_yaml_file)
3. [High Level API for scaling, training and predicion](https://github.com/ricosjp/phlower/tutorials/basic_usages/03_high_level_api_for_scaling_training_and_prediction)



## Usage

**phlower** can be installed with pip. Python 3.10 or newer is supported.

```
pip install phlower
```


