OceanData
=========



The OceanData service provides access to scientific ocean data including
temperature and sea level.

For more information, check out:

- http://www.columbia.edu/~mhs119/Sensitivity+SL+CO2/
- https://www.paleo.bristol.ac.uk/~ggdjl/warm_climates/hansen_etal.pdf.



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: OceanData.getDeepOceanTemp(startYear: Number?, endYear: Number?)

    Get historical deep ocean temperatures in Celsius by year.
    
    If ``startYear`` or ``endYear`` is provided, only measurements within the given range will be returned.

    **Arguments:**

    - ``startYear: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - earliest year to include in results
    - ``endYear: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - latest year to include in results

    **Returns:** ``List`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - a list of deep ocean temperatures by year


.. function:: OceanData.getOxygenRatio(startYear: Number?, endYear: Number?)

    Get historical oxygen isotope ratio values by year.
    
    If ``startYear`` or ``endYear`` is provided, only measurements within the given range will be returned.

    **Arguments:**

    - ``startYear: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - earliest year to include in results
    - ``endYear: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - latest year to include in results

    **Returns:** ``List`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - a list of oxygen isotope ratios by year


.. function:: OceanData.getSeaLevel(startYear: Number?, endYear: Number?)

    Get historical sea level in meters by year.
    
    If ``startYear`` or ``endYear`` is provided, only measurements within the given range will be returned.

    **Arguments:**

    - ``startYear: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - earliest year to include in results
    - ``endYear: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - latest year to include in results

    **Returns:** ``List`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - a list of change in sea level (in meters) by year


.. function:: OceanData.getSurfaceTemp(startYear: Number?, endYear: Number?)

    Get historical surface ocean temperatures in Celsius by year.
    
    If ``startYear`` or ``endYear`` is provided, only measurements within the given range will be returned.

    **Arguments:**

    - ``startYear: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - earliest year to include in results
    - ``endYear: Number?`` (`Number </docs/fundamentals/rpc-arg-types.html#Number>`__) - latest year to include in results

    **Returns:** ``List`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - a list of surface ocean temperatures by year