Metadata-Version: 2.4
Name: cool_maps
Version: 1.0.2
Summary: Helper functions around cartopy for plotting data on maps. These functions are written to easily generate nice-looking maps.
Home-page: https://github.com/rucool/cool_maps
Author: Michael Smith
Author-email: michaesm@marine.rutgers.edu
License: MIT
Keywords: cool_maps
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: cartopy
Requires-Dist: matplotlib
Requires-Dist: cmocean
Requires-Dist: oceans
Requires-Dist: numpy
Requires-Dist: xarray
Requires-Dist: erddapy
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

======
Readme
======


.. .. image:: https://img.shields.io/pypi/v/cool_maps.svg
..     :target: https://pypi.python.org/pypi/cool_maps

.. .. image:: https://readthedocs.org/projects/cool_maps/badge/?version=latest
..         :target: https://cool_maps.readthedocs.io/en/latest/?version=latest
..         :alt: Documentation Status
    
.. .. image:: https://github.com/rucool/cool_maps/actions/workflows/python-package.yml/badge.sv



cool_maps is a package containing functions that utilizearound the cartopy for plotting data on maps. 

These functions are written to easily generate maps using pre-defined settings that our lab, Rutgers Center for Ocean Observing Leadership, prefers to use.


============
Installation
============


Stable release
--------------
We recommend using miniconda to manage your Python environments. Download and follow the `Miniconda installation guide`_ for the appropriate
Miniconda installer for your operating system. 

.. _Miniconda installation guide: http://conda.pydata.org/miniconda.html

Install with conda:

.. code-block:: console

    $ conda install -c conda-forge cool_maps


From sources
------------

The sources for cool_maps can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/rucool/cool_maps

Or download the `tarball`_:

.. code-block:: console

    $ curl -OJL https://github.com/rucool/cool_maps/tarball/master

Change your directory to the source code of cool_maps 

.. code-block:: console

    $ cd ~/cool_maps


Once you are in the correct directory, there are two ways to install from source. 

Method 1:

.. code-block:: console

    $ python setup.py install

Method 2:

.. code-block:: console

    $ pip install .


.. _Github repo: https://github.com/rucool/cool_maps
.. _tarball: https://github.com/rucool/cool_maps/tarball/master

=======
History
=======

0.0.6 (2022-09-21)
------------------

* Create conda build for conda-forge
* Add Sphinx documentation

0.0.3 (2022-07-20)
------------------

* Create conda build

0.0.2 (2022-07-19)
------------------

* Initial commit to GitHub
