Metadata-Version: 2.1
Name: mpnm
Version: 2024.8.31.16.31
Summary: My short description for my project.
Home-page: https://github.com/yojeep/multi-physic-network-model
Author: yojeep
Author-email: 1379690602@qq.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: numba
Requires-Dist: pypardiso
Requires-Dist: scipy
Requires-Dist: meshio
Requires-Dist: vtk
Requires-Dist: pandas
Requires-Dist: scikit-learn


# About Multi-physics Network Model (MpNM)
MpNM is a network model framework for simulating multi-physics processes (e.g. flow and heat) in porous media written in Python, which is developed by Zhejiang University and Imperial College London. In addition to standard network model using a single pore network (e.g. generated by pnextract developed by Imperial College London), MpNM can link two networks (e.g. pore network and solid network dual-network model) to simulated coupled mass and heat transfer in both pore space and solid phase. This model is compatible with the pore network extraction algorithm developed by Imperial College London (https://github.com/ImperialCollegeLondon/pnextract) and GenExtract(https://github.com/iPMLab/GenExtract). The source code is being prepared into different modules and will be uploaded continuously with the example datasets for demonstration.

# How to install?
```
pip install mpnm
```
# How to use?
```
from MpNM import network,topotools,algorithm
```
## Example 1 Absolute permeability (Being upload)

Folder ```sample_data/Bead_packing``` is the example computing absolute permeability. There are four required input network files (*_link1.dat, *_link2.dat, *_node1.dat, *_node2.dat). These files can be generated using pnextract (https://github.com/ImperialCollegeLondon/pnextract).

* Locate the folder ```single_phase_flow```
```
python single_phase_permeability.py 
```
## Example 2 Coupled heat and mass transfer
This example is to simulate heat and mass transfer using a dual-network. 

# Contact
Please contact us if you need more demos or information:

Qingyang Lin - qingyan_lin@zju.edu.cn
Mingliang Qu - mingliangqu@zju.edu.cn
