https://github.com/digital-porous-media/pylbpm
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.3%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: digital-porous-media
- License: bsd-2-clause
- Language: Python
- Default Branch: main
- Size: 1.85 MB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
pyLBPM
A python-based management interface for the LBPM software
Installation
To install pyLBPM with pip (note Python installs scripts to $HOME/.local/.bin)
git clone git@github.com:digital-porous-media/pyLBPM.git
cd pyLBPM
pip install ./
export PATH=$HOME/.local/bin:$PATH
⚠️ Note
It is best to run the following lines from nodes with access to a GPU. On Texas Advanced Computing Center (TACC) systems, this can be done using an interactive development session. The total installation time takes 1-2 hours.
Accessing idev on TACC Vista
bash
idev -p gh-dev -t 2:00:00
module load gcc cuda python3
Accessing idev on TACC Lonestar6
```bash idev -p gpu-a100-small -t 2:00:00 module load gcc/9.4.0 cuda ```To download LBPM dependencies, launch a Python command prompt and run the following from the Python command line.
``` from pyLBPM import lbpmsetup lbpminstallpath="~/local" lbpmconfigsetup=lbpmsetup.downloaddependencies(lbpminstallpath) lbpmconfigsetup=lbpmsetup.installdependencies(lbpminstall_path)
```
To install LBPM from the python command line
from pyLBPM import lbpm_setup
lbpm_install_path="~/local"
lbpm_config_setup=lbpm_setup.install_lbpm(lbpm_install_path)
Launching simulations
Step 1. Set up a working directory for your simulation
SIMDIR=/path/to/my/simulation
mkdir -p $SIMDIR
Step 2. Run example scripts to setup a simple simulation (modify as needed to suit your case)
python example/setup_color_simulation.py $SIMDIR
Step 3.
Launch the simulation (should capture local build environment from config files)
python example/launch_color.py $SIMDIR
Managing simulation data
From the python command line
sdir="/path/to/my/simulation"
from pyLBPM import lbpm_color_model
timelog=lbpm_color_model.read_timelog(simulation_directory=sdir, plot_data=False)
print(timelog)
Visualizing simulation data
To do: write a python interface to read LBPM HDF5 files
Owner
- Name: Digital Porous Media
- Login: digital-porous-media
- Kind: organization
- Email: bcchang@utexas.edu
- Website: https://www.digitalrocksportal.org/
- Repositories: 1
- Profile: https://github.com/digital-porous-media
GitHub Events
Total
- Push event: 3
Last Year
- Push event: 3
Dependencies
- matplotlib *
- numpy *
- pandas *
- pathlib *
- pyyaml *