Metadata-Version: 2.1
Name: esm-analysis
Version: 0.4.2
Summary: Analysis Scripts for ESM Simulations
Home-page: https://github.com/pgierz/esm_analysis
Author: Paul Gierz
Author-email: pgierz@awi.de
License: GNU General Public License v3
Keywords: esm_analysis
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: cdo
Requires-Dist: Click (>=6.0)
Requires-Dist: pandas
Requires-Dist: tabulate
Requires-Dist: regex-engine
Requires-Dist: pyyaml

============
ESM Analysis
============


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

.. image:: https://img.shields.io/travis/pgierz/esm_analysis.svg
        :target: https://travis-ci.org/pgierz/esm_analysis

.. image:: https://readthedocs.org/projects/esm-tools-analysis/badge/?version=latest
        :target: https://esm-tools-analysis.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


Analysis Scripts for ESM Simulations


Quickstart
----------

``esm_analysis`` is the sugar for your bitter CDO-coffee. Check it out:

Install ``esm_analysis`` with::

    pip install esm_analysis

Go to an experiment::

    cd /work/ba0989/a270077/AWICM_PISM/LGM_011

Get a climatology::

    esm_analysis newest-climatology temp2
    esm_analysis newest-climatology thetao

Calculate AMOC::

    esm_analysis amoc

Isn't that better than this?

.. code-block:: shell

    outdata_dir=... # oh man now I need to figure out where the outdata is
    expid=PI # ...uh...PI, I guess?...
    outfile=test.nc # ...I guess I should think of a real name for my output
    vars=temp2 # Oh! I know that one!
    filepattern="echam6_echam"
    fileext=".nc" # Aww geez I have no idea. Is it nc? grb? Let's just guess...
    # How did cdo work again?
    cdo -h select
    cdo -h timmmean
    # Ok, now I think I know what I want:
    cdo -f nc -t echam6 -timmean -select,name=$vars ${outdata_dir}/${expid}_${filepattern}${fileext} $outfile

I'd support the following hypothesis: you clearly don't want to type all that stuff
out. Just say what you want. Easy, right?

The computer should be able to figure out the rest for you. If Google can
predict where I get my breakfast, why can't my computer figure out what ``CDO``
command I want to use??

Features
--------

* Command line interface to quickly create common analyses
* Python library usage
* Free software: GNU General Public License v3
* Documentation: https://esm-tools-analysis.readthedocs.io.


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

This project was inspired by the many headaches caused by it not existing.
Here's what has happened so far:

0.4.2 (2020-02-04)
------------------
* Closes #4

0.4.1 (2020-02-04)
------------------
* Minor documentation update.

0.4.0 (2020-02-03)
------------------
* ``FESOM 1.4`` climatologies

0.3.4 (2020-01-31)
------------------
* Docs fixup
* Links in wrong place in README.

0.3.3 (2020-01-31)
------------------

* Adds version information with ``--version``
* Fixup for multiple files having the requested variable

0.3.2 (2019-12-18)
------------------

* Bad test fix

0.3.1 (2019-12-18)
------------------

* Fixes a permission error

0.3.0 (2019-12-18)
------------------

* Adds utility to parse compute log and provide some statistics on queuing time
  and throughput
* If multiple files have the same variable, ask user which filepattern to use
* Newest climatology for ``ECHAM6``

0.2.0 (2019-12-17)
------------------

* Asks user to create top level file if it isn't found

0.1.1 (2019-12-17)
------------------

* Process files in chunks for ``ECHAM6``

0.1.0 (2019-08-09)
------------------

* First release on PyPI.


