Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 1.22 KB

README.md

File metadata and controls

23 lines (19 loc) · 1.22 KB

Python Wrapper for NextGen In A Box (NGIAB)

Python wrapper for NGIAB's shell scripts. This will facilitate NGIAB invocation directly from Jupyter environment without the need to execute terminal commands.

This wrapper requires NGIAB already setup so should be tested and run inside NGIAB docker or natively setup NGIAB.

Getting Started

  • Follow "Quick Start Guide" from NGIAB to get sample data
  • docker/docker_run.sh modifies the official NGIAB docker to run NGIAB container with a shell. Modify /data mount to point to sample data directory
  • ngiab.py has the python wrapper code
  • test_ngiab.py has code showing usage of the python wrapper module
    • The same can be done in a Jupyter environment launched with all NGIAB dependencies
from ngiab import NGIAB
data_dir = '/data/AWI_16_2863657_007'

# default parallel execution of the model with all available cores
test_ngiab = NGIAB(data_dir)
test_ngiab.run()

# serial execution of the model
test_ngiab_serial = NGIAB(data_dir, serial_execution_mode=True)
test_ngiab_serial.run()