Enhancing documentation: overview and references

README.md

@@ -1,13 +1,32 @@
 # LorenzCycleToolkit
 
 ## Overview
-The LorenzCycleToolkit is a tool for calculating the Lorenz Energy Cycle (LEC) in specific atmospheric regions. The LEC, introduced by Edward Lorenz in 1965, is an analytical framework used to estimate atmospheric energy, including zonal and eddy components of Kinetic and Available Potential Energy, and conversions between these forms.
 
-## Features
-- Fixed (Eulerian) Framework
-- Moving (Semi-Lagrangian) Framework
-- Interactive Domain Selection
-- Comprehensive energy calculations and visualizations
+The LorenzCycleToolkit is a tool for calculating the Lorenz Energy Cycle (LEC) in specific atmospheric regions. Introduced by Edward Lorenz in 1965, the LEC estimates atmospheric energy, including zonal and eddy components of Kinetic and Available Potential Energy, and the conversions between these forms.
+
+### Importance
+
+- **Climate Studies:** Improves understanding of energy exchanges, aiding climate predictions.
+- **Weather Prediction:** Comparison tool for weather models and forecasts.
+- **Research and Education:** Provides a structured approach for analyzing atmospheric energy flows.
+- **Environmental Diagnostics:** Serves as a diagnostic tool for atmospheric dynamics.
+
+### Applications
+
+- **Synoptic-Scale Phenomena:** Study extratropical cyclones and convergence zones.
+- **Mesoscale Phenomena:** Analyze energy transformations in tropical cyclones.
+- **Model Comparison:** Compare model dynamics with reanalysis data.
+
+### Features
+
+- **Flexible Frameworks:** Analyze fixed regions using Eulerian or Semi-Lagrangian frameworks.
+- **User-Friendly:** Simple command-line interface without needing to program scripts.
+- **Customizable Inputs:** Define custom domains and variable configurations.
+- **Visualization Options:** Generate detailed plots to visualize the energy cycle components.
+
+## Documentation
+
+For detailed documentation and usage instructions, visit the [LorenzCycleToolkit Documentation](https://daniloceano.github.io/LorenzCycleToolkit/).
 
 ## Installation
 To install the required dependencies, use the provided `requirements.txt` file:
@@ -23,10 +42,6 @@ python lorenzcycletoolkit.py samples/testdata_ERA5.nc -r -f
 
 For more detailed usage instructions, including configuration options and examples, please refer to the documentation.
 
-## Documentation
-
-For detailed documentation and usage instructions, visit the [LorenzCycleToolkit Documentation](https://daniloceano.github.io/LorenzCycleToolkit/).
-
 ## Contributing
 Contributions are welcome! Please see the [contributing guide](CONTRIBUTING.md) for more details.
 

docs/source/references.rst

@@ -1,5 +1,9 @@
 References
 ==========
 
-- Lorenz, E. N. (1965). A study of the predictability of a 28-variable atmospheric model. Tellus, 17(3), 321-333.
-- Relevant articles and documentation related to the Lorenz Energy Cycle.
+- Lorenz, E. N. (1955). Available potential energy and the maintenance of the general circulation. Tellus, 7(2), 157-167.
+- Muench, H. S. (1965). On the dynamics of the wintertime stratosphere circulation. Journal of Atmospheric Sciences, 22(4), 349-360.
+- Brennan, F. E., & Vincent, D. G. (1980). Zonal and eddy components of the synoptic-scale energy budget during intensification of hurricane Carmen (1974). Monthly Weather Review, 108(7), 954-965.
+- Michaelides, S. C. (1987). Limited area energetics of Genoa cyclogenesis. Monthly Weather Review, 115(1), 13-26.
+- Michaelides, S. C., Prezerakos, N. G., & Flocas, H. A. (1999). Quasi‐Lagrangian energetics of an intense Mediterranean cyclone. Quarterly Journal of the Royal Meteorological Society, 125(553), 139-168.
+- Dias Pinto, J. R., & Da Rocha, R. P. (2011). The energy cycle and structural evolution of cyclones over southeastern South America in three case studies. Journal of Geophysical Research: Atmospheres, 116(D14).