Metadata-Version: 2.1
Name: xlayers
Version: 0.2.1
Summary: Fast convective parameters for numpy, dask, and xarray
Home-page: https://github.com/cspencerjones/xlayers
Author: xlayers Developers
Author-email: spencerj@ldeo.columbia.edu
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering

.. image:: https://img.shields.io/pypi/v/xlayers.svg?style=for-the-badge
    :target: https://pypi.org/project/xlayers
    :alt: Python Package Index

.. image:: https://img.shields.io/conda/vn/conda-forge/xlayers.svg?style=for-the-badge
    :target: https://anaconda.org/conda-forge/xlayers
    :alt: Conda Version


xlayers: Python implementation of MITgcm's layer package
========================================================



Installation
------------


xlayers can be installed from PyPI with pip:

.. code-block:: bash

    python -m pip install xlayers


It is also available from `conda-forge` for conda installations:

.. code-block:: bash

    conda install -c conda-forge xlayers

To install xlayers from source repository, the fortran-compiler package is required. The easiest way to install the fortran-compiler is via `conda`_ :

.. code-block:: bash

    conda install -c conda-forge fortran-compiler
    unset LDFLAGS

.. _conda: https://conda-forge.org/

Once the compiler is installed, now we can install xlayers from Github:

.. code-block:: bash

    git clone https://github.com/cspencerjones/xlayers.git
    cd xlayers
    python setup.py install


Get in touch
------------

- Report bugs, suggest features or view the source code `on GitHub`_.

.. _on GitHub: https://github.com/cspencerjones/xlayers.git


