Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

hn2016_falwa

A Python library for computing Finite-Amplitude Local Wave Activity from climate data.
https://github.com/csyhuang/hn2016_falwa

Category: Climate Change
Sub Category: Climate Data Processing and Analysis

Keywords

climate climate-analysis climate-data climate-data-analysis climate-science hacktoberfest python science science-research

Keywords from Contributors

archiving transforms measur generic optimize observation compose conversion projection animals

Last synced: about 13 hours ago
JSON representation

Repository metadata

Python library for computing Finite-Amplitude Local Wave Activity Diagnostics from climate data.

readme.md

Python Library: falwa (v2.1.0)

Python packagecodecov.ioDocumentation StatusDOI

Important: this python package has been renamed from hn2016_falwa to falwa since version v1.0.0.

hn2016_falwa_diagram

Compute from gridded climate data the Finite-amplitude Local Wave Activity (FALWA) and flux terms introduced in:

Package Installation

Attention: substantial changes took place in release v2.0.0. Installation in develop mode is no longer available.

Since release v2.0.0, the F2PY modules in falwa is compiled with meson (See Issue #95 for details) to cope with the deprecation of numpy.disutils in python 3.12.

First-time installation

  1. To build the package from source, you need a fortran compiler (e.g., gfortran) to implement the installation.
  2. Clone the package repo by git clone https://github.com/csyhuang/hn2016_falwa.git .
  3. Navigate into the repository and set up a python environment satisfying the installation requirement by conda env create -f environment.yml. The environment name in the file is set to be falwa_env (which users can change).
  4. Install the package with the command python -m pip install .. The compile modules will be saved to python site-packages directory.
  5. If the installation is successful, you should be able to run through all unit tests in the folder tests/ by executing pytest tests/.

Get updated code from new releases

  1. To incorporate updates, first, pull the new version of the code from GitHub by git pull.
  2. Uninstall existing version of falwa: pip uninstall falwa
  3. If there is change in environment.yml, remove the existing environment by conda remove --name falwa_env --all and create the environment again from the updated YML file: conda env create -f environment.yml.
  4. Reinstall the updated version by python -m pip install ..
  5. Run through all unit tests in the folder tests/ by executing pytest tests/ to make sure the package has been properly installed.

Quick start

There are some readily run python scripts (in scripts/) and jupyter notebooks (in notebooks/) which you can start with.
The netCDF files needed can be found in Clare's Dropbox folder.

Depending on what you want to do, the methods to be use may be different.

  1. If you solely want to compute equivalent latitude and local wave activity from a 2D field, you can refer to notebooks/simple/Example_barotropic.ipynb. This is useful for users who want to use LWA to quantify field anomalies.

  2. If you want to compute zonal wind reference states and wave activity fluxes in QG Formalism, look at notebooks/nh2018_science/demo_script_for_nh2018.ipynb for the usage of QGField. This notebook demonstrates how to compute wave activity and reference states presented in Nakamura and Huang (2018). To make sure the package is properly installed in your environment, run through the notebook after installation to see if there is error.

Inquiries / Issues reporting

  • If you are interested in getting email message related to update of this package, please leave your contact here such that I can keep you updated of any changes made.
  • If you encounter coding issues/bugs when using the package, please create an Issue ticket.
  • If you have scientific questions, please create a thread in the Discussion Board with the category "General" or "Q&A" according to the circumstance.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 551
Total Committers: 7
Avg Commits per committer: 78.714
Development Distribution Score (DDS): 0.113

Commits in past year: 62
Committers in past year: 3
Avg Commits per committer in past year: 20.667
Development Distribution Score (DDS) in past year: 0.097

Name Email Commits
csyhuang c****g@u****u 489
Christopher Polster c****e@t****o 43
Pragallva Barpanda p****a@l****o 9
veredsil v****n@g****m 4
dependabot[bot] 4****] 3
Shao Ying Huang c****g@w****u 2
Huang, Clare c****g@c****m 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 80
Total pull requests: 54
Average time to close issues: 4 months
Average time to close pull requests: 12 days
Total issue authors: 14
Total pull request authors: 5
Average comments per issue: 1.79
Average comments per pull request: 1.17
Merged pull request: 48
Bot issues: 0
Bot pull requests: 4

Past year issues: 16
Past year pull requests: 9
Past year average time to close issues: 3 months
Past year average time to close pull requests: 6 days
Past year issue authors: 2
Past year pull request authors: 3
Past year average comments per issue: 0.81
Past year average comments per pull request: 1.89
Past year merged pull request: 7
Past year bot issues: 0
Past year bot pull requests: 1

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/csyhuang/hn2016_falwa

Top Issue Authors

  • csyhuang (58)
  • sandrolubis (4)
  • Pragallva (2)
  • miniufo (2)
  • hs2112 (2)
  • Veenarinesingh (2)
  • chpolste (2)
  • AminFazlKazemi (2)
  • hungilee (1)
  • chauncy-git (1)
  • GuidoDavoli (1)
  • semvijverberg (1)
  • paologhinassi (1)
  • mpecnjak (1)

Top Pull Request Authors

  • csyhuang (34)
  • chpolste (13)
  • dependabot[bot] (4)
  • Pragallva (2)
  • veredsil (1)

Top Issue Labels

  • enhancement (11)
  • MDTF (11)
  • contributions welcome (10)
  • help wanted (5)
  • release2.1 (5)
  • release1.3 (5)
  • scientific question (4)
  • bug (4)
  • release2.2 (2)
  • good first issue (1)
  • Hacktoberfest (1)

Top Pull Request Labels

  • dependencies (4)
  • release2.2 (2)
  • release1.0 (1)
  • release (1)
  • release2.1 (1)

Package metadata

pypi.org: hn2016-falwa

This python package has been renamed from `hn2016_falwa` to `falwa` since version v1.0.0.

  • Homepage: https://github.com/csyhuang/hn2016_falwa
  • Documentation: https://hn2016-falwa.readthedocs.io/
  • Licenses: MIT
  • Latest release: 0.7.3 (published over 1 year ago)
  • Last Synced: 2025-04-25T13:04:59.229Z (1 day ago)
  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 478 Last month
  • Rankings:
    • Dependent packages count: 7.303%
    • Forks count: 10.199%
    • Stargazers count: 12.055%
    • Average: 14.951%
    • Dependent repos count: 22.068%
    • Downloads: 23.128%
  • Maintainers (1)
pypi.org: falwa

Python package to compute finite-amplitude local wave activity diagnostics (Huang and Nakamura 2016, JAS)

  • Homepage:
  • Documentation: https://hn2016-falwa.readthedocs.io/
  • Licenses: Copyright (c) 2015-2024 Clare S. Y. Huang Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 2.1.0 (published about 1 month ago)
  • Last Synced: 2025-04-25T13:04:59.250Z (1 day ago)
  • Versions: 7
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 337 Last month
  • Rankings:
    • Dependent packages count: 9.964%
    • Forks count: 10.177%
    • Stargazers count: 12.034%
    • Average: 24.981%
    • Dependent repos count: 67.747%
  • Maintainers (1)

Dependencies

environment.yml conda
  • numpy
  • pytest
  • scipy
  • xarray
examples/environment.yml conda
  • ecmwfapi
  • jupyterlab
  • matplotlib 2.2.2.*
  • netcdf4
  • numpy
  • pytest
  • scipy
docs/requirements.txt pypi
  • numpy *
  • readthedocs-sphinx-search ==0.1.1
  • scipy *
  • sphinx ==3.2.1
  • sphinx_rtd_theme ==1.0.0
  • xarray *
requirements.txt pypi
  • numpy *
  • pytest *
  • scipy *
  • xarray *
.github/workflows/workflow.yml actions
  • actions/checkout v2 composite
  • actions/setup-python master composite

Score: 12.481413882147155