wam2layers


Namewam2layers JSON
Version 3.2.0 PyPI version JSON
download
home_pageNone
SummaryAtmospheric moisture tracking model
upload_time2024-12-20 15:08:24
maintainerNone
docs_urlNone
authorNone
requires_python<3.13,>=3.9
licenseApache 2.0
keywords atmospheric rivers hydrological cycle meteorology moisture recycling moisture tracking
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# WAM2layers

[![DOI](https://zenodo.org/badge/471007521.svg)](https://zenodo.org/badge/latestdoi/471007521)
[![Documentation Status](https://readthedocs.org/projects/wam2layers/badge/?version=latest)](https://wam2layers.readthedocs.io/en/latest/?badge=latest)
[![PyPI](https://img.shields.io/pypi/v/wam2layers)](https://pypi.org/project/wam2layers/)

WAM2layers is an atmospheric moisture tracking model. It can be used to determine where
precipitation originally evaporated (backtracking), or where evaporated moisture
eventually ends up (forward tracking).

Reference paper: [Atmospheric moisture tracking with WAM2layers v3](https://doi.org/10.5194/egusphere-2024-3401)

https://user-images.githubusercontent.com/17080502/233834536-a82ca96d-e303-4592-a588-472097ebe6c5.mp4

The animation above illustrates the concept of backtracking: you first see the water
content and fluxes move forward in time (left panel). Midway through, the animation
reverses and the moisture from the "source region" is tracked backward in time (right panel).

## How does it work

The simplest experiment with WAM2layers could look like this

```sh
pip install wam2layers[viz]
wam2layers download example-input-eiffel
cd example-input-eiffel
wam2layers preprocess era5 config-eiffel.yaml
wam2layers track config-eiffel.yaml
wam2layers visualize output config-eiffel.yaml
```

See the [documentation](https://wam2layers.readthedocs.io/en/latest/) for a more detailed description. We also have a [video walkthrough](https://youtu.be/QudlILlZnOg)!

## Finding help

```mermaid
graph TD
    A[Question or idea?] --> B[Check existing resources:<br><a href='https://wam2layers.readthedocs.io'>Documentation</a>, <a href='https://github.com/WAM2layers/WAM2layers/discussions'>Discussion forum</a>, <a href='https://github.com/WAM2layers/WAM2layers/issues'>Open issues</a>]
    B --> |Still unresolved?| C[<a href="https://github.com/WAM2layers/WAM2layers/discussions/new">Start a new discussion</a><br>Briefly introduce yourself and your use case and provide relevant context, e.g. config files]
    C --> |Work needed?| D[Discussion is converted to issue]
    D --> |Want to contribute?| E[See <a href='https://wam2layers.readthedocs.io/en/latest/develop.html'>Developer guide</a>]
    D --> F[Wait for others to hopefully work on it]

    class A startStep;
    classDef startStep fill:#f9f,stroke:#333,stroke-width:4px,font-size:16px;
```

# Other versions

This is the official codebase for the WAM-2layers moisture tracking model as of
18/03/2022, but there are still several other (older) versions around:

- [Original Python code for ERA-Interim by Ruud van der Ent](https://github.com/ruudvdent/WAM2layersPython)
- [Adapted version for EC-Earth by Imme Benedict](https://github.com/Imme1992/moisture_tracking_mississippi)
- [Adapted version for MERRA2 by Pat Keys](https://github.com/pkeys/WAM2layersPythonMerra2)
- [Adapted version for ERA5 pressure levels by Mingzhong Xiao](https://zenodo.org/record/4796962#.Y25d1-TMIVA)
- [Adapted version for ERA5 by Theo Carr](https://github.com/ktcarr/WAM2layers_ERA5)

# Reuse and acknowledgement

This code is currently developed by a core team:
Ruud van der Ent (Delft University of Technology)
Imme Benedict (Wageningen University)
Chris Weijenborg (Wageningen University)
Peter Kalverla (Netherlands eScienceCenter)
Bart Schilperoort (Netherlands eScience Center)

We are proudly part of [open-sustainable-technology](https://github.com/protontypes/open-sustainable-technology).

If you use the code for a publication, please cite it using the [DOI of the
appropriate release](https://doi.org/10.5281/zenodo.7010594) and the
following paper (currently in preprint):
[Atmospheric moisture tracking with WAM2layers v3](https://doi.org/10.5194/egusphere-2024-3401)

<p align='right'>
<img src="https://github.com/user-attachments/assets/6d553165-88d5-40d3-8def-2aec45cb695b" width="100"/>
<img src="https://github.com/user-attachments/assets/99617790-ae0c-484c-971d-d9a7e0d8da5a" width="100"/>
<img src="https://github.com/user-attachments/assets/fb29f5ab-bdb5-4008-b6a7-3b44c6b1f5a1" width="100"/>
</p>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "wam2layers",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.9",
    "maintainer_email": null,
    "keywords": "atmospheric rivers, hydrological cycle, meteorology, moisture recycling, moisture tracking",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a1/ec/676d964bced3f80a80060f86b419ec2a949e685f40987e8e0b764fe27ab2/wam2layers-3.2.0.tar.gz",
    "platform": null,
    "description": "\n# WAM2layers\n\n[![DOI](https://zenodo.org/badge/471007521.svg)](https://zenodo.org/badge/latestdoi/471007521)\n[![Documentation Status](https://readthedocs.org/projects/wam2layers/badge/?version=latest)](https://wam2layers.readthedocs.io/en/latest/?badge=latest)\n[![PyPI](https://img.shields.io/pypi/v/wam2layers)](https://pypi.org/project/wam2layers/)\n\nWAM2layers is an atmospheric moisture tracking model. It can be used to determine where\nprecipitation originally evaporated (backtracking), or where evaporated moisture\neventually ends up (forward tracking).\n\nReference paper: [Atmospheric moisture tracking with WAM2layers v3](https://doi.org/10.5194/egusphere-2024-3401)\n\nhttps://user-images.githubusercontent.com/17080502/233834536-a82ca96d-e303-4592-a588-472097ebe6c5.mp4\n\nThe animation above illustrates the concept of backtracking: you first see the water\ncontent and fluxes move forward in time (left panel). Midway through, the animation\nreverses and the moisture from the \"source region\" is tracked backward in time (right panel).\n\n## How does it work\n\nThe simplest experiment with WAM2layers could look like this\n\n```sh\npip install wam2layers[viz]\nwam2layers download example-input-eiffel\ncd example-input-eiffel\nwam2layers preprocess era5 config-eiffel.yaml\nwam2layers track config-eiffel.yaml\nwam2layers visualize output config-eiffel.yaml\n```\n\nSee the [documentation](https://wam2layers.readthedocs.io/en/latest/) for a more detailed description. We also have a [video walkthrough](https://youtu.be/QudlILlZnOg)!\n\n## Finding help\n\n```mermaid\ngraph TD\n    A[Question or idea?] --> B[Check existing resources:<br><a href='https://wam2layers.readthedocs.io'>Documentation</a>, <a href='https://github.com/WAM2layers/WAM2layers/discussions'>Discussion forum</a>, <a href='https://github.com/WAM2layers/WAM2layers/issues'>Open issues</a>]\n    B --> |Still unresolved?| C[<a href=\"https://github.com/WAM2layers/WAM2layers/discussions/new\">Start a new discussion</a><br>Briefly introduce yourself and your use case and provide relevant context, e.g. config files]\n    C --> |Work needed?| D[Discussion is converted to issue]\n    D --> |Want to contribute?| E[See <a href='https://wam2layers.readthedocs.io/en/latest/develop.html'>Developer guide</a>]\n    D --> F[Wait for others to hopefully work on it]\n\n    class A startStep;\n    classDef startStep fill:#f9f,stroke:#333,stroke-width:4px,font-size:16px;\n```\n\n# Other versions\n\nThis is the official codebase for the WAM-2layers moisture tracking model as of\n18/03/2022, but there are still several other (older) versions around:\n\n- [Original Python code for ERA-Interim by Ruud van der Ent](https://github.com/ruudvdent/WAM2layersPython)\n- [Adapted version for EC-Earth by Imme Benedict](https://github.com/Imme1992/moisture_tracking_mississippi)\n- [Adapted version for MERRA2 by Pat Keys](https://github.com/pkeys/WAM2layersPythonMerra2)\n- [Adapted version for ERA5 pressure levels by Mingzhong Xiao](https://zenodo.org/record/4796962#.Y25d1-TMIVA)\n- [Adapted version for ERA5 by Theo Carr](https://github.com/ktcarr/WAM2layers_ERA5)\n\n# Reuse and acknowledgement\n\nThis code is currently developed by a core team:\nRuud van der Ent (Delft University of Technology)\nImme Benedict (Wageningen University)\nChris Weijenborg (Wageningen University)\nPeter Kalverla (Netherlands eScienceCenter)\nBart Schilperoort (Netherlands eScience Center)\n\nWe are proudly part of [open-sustainable-technology](https://github.com/protontypes/open-sustainable-technology).\n\nIf you use the code for a publication, please cite it using the [DOI of the\nappropriate release](https://doi.org/10.5281/zenodo.7010594) and the\nfollowing paper (currently in preprint):\n[Atmospheric moisture tracking with WAM2layers v3](https://doi.org/10.5194/egusphere-2024-3401)\n\n<p align='right'>\n<img src=\"https://github.com/user-attachments/assets/6d553165-88d5-40d3-8def-2aec45cb695b\" width=\"100\"/>\n<img src=\"https://github.com/user-attachments/assets/99617790-ae0c-484c-971d-d9a7e0d8da5a\" width=\"100\"/>\n<img src=\"https://github.com/user-attachments/assets/fb29f5ab-bdb5-4008-b6a7-3b44c6b1f5a1\" width=\"100\"/>\n</p>\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "Atmospheric moisture tracking model",
    "version": "3.2.0",
    "project_urls": {
        "Documentation": "https://wam2layers.readthedocs.io/en/latest",
        "Source code": "https://github.com/WAM2layers/WAM2layers"
    },
    "split_keywords": [
        "atmospheric rivers",
        " hydrological cycle",
        " meteorology",
        " moisture recycling",
        " moisture tracking"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d63f66db55b08b719a4f55a0353ed2d8dd34fcb092489f74b983c92edcc13219",
                "md5": "fe3084c41500a22811f31030b9ecdb6d",
                "sha256": "0895056c63d6374a5d44474aa82c9e79ebdf05e95f63c3739ccce1b4956a493f"
            },
            "downloads": -1,
            "filename": "wam2layers-3.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fe3084c41500a22811f31030b9ecdb6d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.9",
            "size": 67108,
            "upload_time": "2024-12-20T15:08:21",
            "upload_time_iso_8601": "2024-12-20T15:08:21.961614Z",
            "url": "https://files.pythonhosted.org/packages/d6/3f/66db55b08b719a4f55a0353ed2d8dd34fcb092489f74b983c92edcc13219/wam2layers-3.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1ec676d964bced3f80a80060f86b419ec2a949e685f40987e8e0b764fe27ab2",
                "md5": "a3cf3748e9880437ba5cce884501ee5f",
                "sha256": "6a877106ef8a1669aeb6274b7e94eb0cc3e1a813464a1b904af766eb3d509ba9"
            },
            "downloads": -1,
            "filename": "wam2layers-3.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a3cf3748e9880437ba5cce884501ee5f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.9",
            "size": 62583,
            "upload_time": "2024-12-20T15:08:24",
            "upload_time_iso_8601": "2024-12-20T15:08:24.420102Z",
            "url": "https://files.pythonhosted.org/packages/a1/ec/676d964bced3f80a80060f86b419ec2a949e685f40987e8e0b764fe27ab2/wam2layers-3.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-20 15:08:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "WAM2layers",
    "github_project": "WAM2layers",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "wam2layers"
}
        
Elapsed time: 0.62807s