Skip to content

Latest commit

 

History

History
78 lines (45 loc) · 1.47 KB

index.rst

File metadata and controls

78 lines (45 loc) · 1.47 KB

qiutil - Quantitative Imaging Utilities

Synopsis

qiutil provides general-purpose utilities for the OHSU QIN projects.

API

http://qiutil.readthedocs.org/en/latest/api/index.html

Git

https://www.github.com/ohsu-qin/qiutil

Feature List

  1. Configuration file parser.
  2. Logging configuration.
  3. Command logging options.
  4. Collection data structures and utilities.
  5. File helper functions.
  6. Simple UID generator.

Installation

Add qiutil to your Python project setup.py install_requires.

Development

Testing is performed with the nose package, which must be installed separately.

Documentation is built automatically by ReadTheDocs when the project is pushed to GitHub. Documentation can be generated locally as follows:

  • Install Sphinx, if necessary.
  • Run the following in the doc subdirectory:

    make html

api/index