OilLibrary

OilLibrary is The NOAA library of oils and their properties. It is developed by the National Oceanic and Atmospheric Administration (NOAA), Office of Response and Restoration (ORR), Emergency Response Division.

Installation Instructions

Requirements

The best way to get the requirements is via conda:

conda install --file conda_requirements.txt

Note that some of the packages are only available in conda-forge or NOAA-ORR-ERD channels. To make it easy for your install to find conda-forge and NOAA packages, they should be added to your conda configuration:

First add the NOAA-ORR-ERD channel:

> conda config --add channels NOAA-ORR-ERD

And then add the conda-forge channel:

> conda config --add channels conda-forge

When you add a channel to conda, it puts it at the top of the list. So now when you install a package, conda will first look in conda-forge, then NOAA-ORR-ERD, and then in the default channel. This order should work well for PyGNOME. Be sure to add the channels in the order we specify.

You can see what channels you have with:

> conda config --get channels

It should return something like this:

--add channels 'defaults'   # lowest priority
--add channels 'NOAA-ORR-ERD'
--add channels 'conda-forge'   # highest priority

In that order -- the order is important

Installing from source

cd <directory containing this file>

$venv/bin/python setup.py develop

or:

$venv/bin/python setup.py install

Using the package

The simplest way of using the oil library is through the functions get_oil() and get_oil_props():

> ipython
Python 2.7.11 |Anaconda 2.4.1 (x86_64)| (default, Dec  6 2015, 18:57:58)
Type "copyright", "credits" or "license" for more information.

In [1]: from oil_library import get_oil

In [2]: oil_obj = get_oil('BAHIA')

In [3]: oil_obj
Out[3]: <Oil("BAHIA")>

However, the underlying mechanism of the oil library is a SQL database using SQLAlchemy. So one can do more sophisticated things like:

> ipython
Python 2.7.11 |Anaconda 2.4.1 (x86_64)| (default, Dec  6 2015, 18:57:58)
Type "copyright", "credits" or "license" for more information.

In [1]: from oil_library import get_oil, get_oil_props, _get_db_session

In [2]: from oil_library.models import Oil

In [3]: session = _get_db_session()

In [4]: session.query(Oil.name).all()
Out[4]:
[(u'ABOOZAR, OIL & GAS'),
 (u'ABU SAFAH'),
 (u'ALASKA NORTH SLOPE (MIDDLE PIPELINE)'),
 ...
 ...
 (u'ZETA NORTH'),
 (u'ZUATA SWEET, OIL & GAS JOURNAL'),
 (u'ZUEITINA, OIL & GAS')]

In [5]: