Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 1.12 KB

README.md

File metadata and controls

22 lines (18 loc) · 1.12 KB

pylibs

  • Repository of python functions/classes/scripts. This library is designed to handle most of our routine work. Processing SCHISM related work is a significant part of the usgae of this library.

  • In pylibs, there are mainly two groups of functions:

    • generic function: lpfilt, ReadNC, inside_polygon, proj, ...
    • schism-related function: sms2grd, read_schism_hgrid, read_schism_output), ...
  • Installation

    • pip install pylibs-ocean (user mode)
    • pip install pylibs-ocean[mpi,shapefile,projection,eof] (comprehensive user mode)
    • git clone https://github.com/wzhengui/pylibs.git; cd pylibs; pip install -e . (developer mode)
  • Usage

    • explicit import: from pylib import zdata, ReadNC, read_schism_hgrid, sms2grd
    • import mport: from pylib import * (import all)
  • Directories

    • Scripts: sample scripts for using pylibs
    • Utility: python library functions
      • pylib.py: tool for importing all necessary and frequently-used python functions/packages
      • mylib.py: defined functions/classes
      • schism_file.py: schism related functions/classes