Skip to content

Releases: daniloceano/LorenzCycleToolkit

LorenzCycleTookKit v1.0.7

15 Sep 21:44
@daniloceano daniloceano
v1.0.7
daf15e3
Compare
Choose a tag to compare
LorenzCycleTookKit v1.0.7 Latest
Latest

Summary of Changes from 1.0.0 to 1.0.7

  1. Documentation Improvements:

    • Clarified installation instructions and updated license details (GNU).
    • Added a support section and refined tutorials/examples.
    • Corrected links in the README and documentation.

  2. CI/CD Enhancements:

    • Integrated CircleCI for continuous deployment.
    • Ensured proper deployment of documentation with the gh-pages branch.

  3. New Features:

    • Improved user guidelines for using the semi-Lagrangian framework with custom track data.

  4. Initial Release (1.0.0):

    • Core functionality for Lorenz Energy Cycle (LEC) calculations, CSV result generation, and automatic plotting.
Assets 2
Loading

LorenzCycleToolkit v1.0.0

18 Jul 17:03
@daniloceano daniloceano
v1.0.0
3c84bc3
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
LorenzCycleToolkit v1.0.0

LorenzCycleToolkit v1.0.0

We are excited to announce the release of LorenzCycleToolkit v1.0.0! This release marks the first official version of the toolkit, designed to calculate the Lorenz Energy Cycle (LEC) in specific atmospheric regions.

Overview

The LorenzCycleToolkit is a powerful tool for analyzing energy transformations in various atmospheric phenomena. It provides insights into the dynamics of the atmosphere, aiding in weather and climate prediction, and enhancing our understanding of atmospheric processes.

Key Features

  • Lorenz Energy Cycle Calculation: Accurately calculate the LEC, including zonal and eddy components of kinetic and available potential energy, as well as conversions between these forms.

  • Support for Multiple Frameworks:

    • Fixed (Eulerian) Framework: Analyze a fixed region in the atmosphere.
    • Moving (Semi-Lagrangian) Framework: Track atmospheric perturbations with a dynamic domain.
    • Interactive Domain Selection: Choose the domain interactively for each timestep.

  • Comprehensive Output: Generate detailed CSV files with results for each LEC term, including results for each vertical level.

  • Automated Plotting: Optionally generate various plots, such as spatial representations, time series, Hovmöller diagrams, and complete energy flux boxes.

  • Efficient Data Handling: Leverage Xarray, Dask, Pandas, and MetPy for efficient processing and handling of large datasets.

Documentation

Extensive documentation is available here, including installation instructions, usage examples, and detailed descriptions of the input and output files.

Installation

To install LorenzCycleToolkit, follow the instructions in the Installation Guide.

Contributors

This release would not have been possible without the contributions of the following people:

  • Pedro Leite da Silva Dias
  • Matheus Bonjour Laviola da Silva
  • Ricardo de Camargo

How to Cite

If you use LorenzCycleToolkit in your research, please cite the software itself using the following BibTeX entry:

@software{lorenzcycletoolkit,
  author = {Danilo Couto de Souza and Pedro Leite da Silva Dias and Matheus Bonjour Laviola da Silva and Ricardo de Camargo},
  title = {LorenzCycleToolkit: A Comprehensive Python Tool for Analyzing Atmospheric Energy Cycles},
  year = {2024},
  publisher = {GitHub},
  journal = {Pending Publication},
  url = {https://github.com/daniloceano/LorenzCycleToolkit},
}
Assets 2
Loading