https://github.com/ovinc/imbibo
https://github.com/ovinc/imbibo
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ovinc/imbibo
- Owner: ovinc
- License: other
- Created: 2024-11-25T16:04:48.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-11-26T10:08:15.000Z (7 months ago)
- Last Synced: 2025-01-30T03:26:45.106Z (5 months ago)
- Language: Python
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
About
=====
Python 3 package for calculating imbibition and related phenomena, in particular in nanoporous media with water.
Install
=======
```bash
git clone https://github.com/ovinc/imbibo
cd imbibo
pip install -e .
```
Testing
=======
With `pytest`:
```bash
pytest
```
Quick Start
===========
```python
from imbibo import Water, Liquid
from imbibo import PorousMedium, PoreLiquid
water = Water(temperature=25)
porous_silicon = PorousMedium(
pore_radius=2e-9,
porosity=0.4,
tortuosity=4.5,
)
pore_liquid = PoreLiquid(
liquid=water,
porous_medium=porous_silicon,
contact_angle=25,
radius_corr_hydraulic=-0.31e-9,
)
pore_liquid.capillary_pressure # [Pa]
pore_liquid.permeability # [m^2 / (Pa.s)]
pore_liquid.lw_constant # Lucas-Washburn constant w [m^2 / s]
```
Misc. info
==========
Module requirements
-------------------
- aquasol (properties of water and solutions)
- helisol (for the `Angle` class for contact angles)
Python requirements
-------------------
Python : >= 3.7 (dataclasses)
Author
------
Olivier Vincent
License
-------
CeCILL-B (equivalent to BSD, see *LICENSE* file).