gnome.utilities
===============

.. py:module:: gnome.utilities

.. autoapi-nested-parse::

   __init__.py for the utilities package

   a few small things here, 'cause why not?



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/gnome/utilities/appearance/index
   /autoapi/gnome/utilities/cache/index
   /autoapi/gnome/utilities/colormaps/index
   /autoapi/gnome/utilities/compute_fraction/index
   /autoapi/gnome/utilities/convert/index
   /autoapi/gnome/utilities/distributions/index
   /autoapi/gnome/utilities/file_tools/index
   /autoapi/gnome/utilities/geometry/index
   /autoapi/gnome/utilities/graphs/index
   /autoapi/gnome/utilities/hull/index
   /autoapi/gnome/utilities/images2gif/index
   /autoapi/gnome/utilities/inf_datetime/index
   /autoapi/gnome/utilities/map_canvas/index
   /autoapi/gnome/utilities/orderedcollection/index
   /autoapi/gnome/utilities/plotting/index
   /autoapi/gnome/utilities/plume/index
   /autoapi/gnome/utilities/profiledeco/index
   /autoapi/gnome/utilities/projections/index
   /autoapi/gnome/utilities/rand/index
   /autoapi/gnome/utilities/remote_data/index
   /autoapi/gnome/utilities/save_updater/index
   /autoapi/gnome/utilities/schema_decorator/index
   /autoapi/gnome/utilities/serializable_demo_objects/index
   /autoapi/gnome/utilities/shapefile_builder/index
   /autoapi/gnome/utilities/surface_concentration/index
   /autoapi/gnome/utilities/time_utils/index
   /autoapi/gnome/utilities/timeseries/index
   /autoapi/gnome/utilities/transforms/index
   /autoapi/gnome/utilities/weathering/index


Attributes
----------

.. autoapisummary::

   gnome.utilities.div
   gnome.utilities.GetCurrentProcess


Functions
---------

.. autoapisummary::

   gnome.utilities.convert_longitude
   gnome.utilities.round_sf_scalar
   gnome.utilities.round_sf_array
   gnome.utilities.convert_mass_to_mass_or_volume


Package Contents
----------------

.. py:data:: div

.. py:function:: convert_longitude(lon, coord_system='-180--180')

   Convert longitude values to a given coordinate system.

   Options are:

   "-180--180": Negative 180 degrees to 180 degrees

   "0--360": Zero to 360 degrees

   :param lon: numpy array-like of longitude values of float type
   :param  coord_system='-180--180': options are: {"-180--180", "0--360"}

   NOTE: this function also normalizes so that:

   360 converts to 0
   -180 converts to 180

   It should be safe to call this on any coords -- if they are already
   in the expected format, they will not be changed, except for the
   normalization above.


.. py:data:: GetCurrentProcess

.. py:function:: round_sf_scalar(x, sigfigs)

.. py:function:: round_sf_array(x, sigfigs)

   round to a certain number of significant figures

   should work on floats and numpy arrays

   NOTE: This should be vectorizable, but np.round takes only a scalar value
         for number of decimals -- you could vectorize the rest of the computation,
         and then loop for the round, but would that buy anything?
         (or use np.vectorize)


.. py:function:: convert_mass_to_mass_or_volume(in_unit, out_unit, density, value)

   convert a mass unit to either a mass or volume unit

   :param in_unit: units of input, should be a valid mass unit.

   :param out_unit: units you want the result in -- can be a volume or mass unit

   :param density: density to use to convert from mass to volume. has to be kg/m^3

   :param value: value (in in_units) you want converted.

   ex:

   convert_mass_to_mass_or_volume('kg', 'bbl', 950, 2000)

   convert_mass_to_mass_or_volume('lbs', 'kg', 950, 4000)