parmesan 2.0.0

Python Atmospheric Research Package for Meteorological Timeseries Analysis

🧀 PARMESAN

Python Atmospheric Research program for MEteorological Scientific ANalysis

What can PARMESAN do?

PARMESAN is targeted at meteorologists/scientists doing atmospheric measurements who want to analyse their obtained time series, calculate typical temperature, wind, humidity, atmospheric stability and turbulence parameters. PARMESAN provides basic building blocks for typical meteorological calculations and can be easily expanded as equations are based on symbolic mathematics that can be recombined and repurposed.

🔢 Physical Calculations

• 📉 calculating power spectra of timeseries
• 📉 calculating structure functions of timeseries
• ⏱ calculating temporal cycles (e.g. diurnal/daily cycles)
• 🌫 calculating several humidity measures
• 🌡 calculating several temperature measures
• 📜 handling physical units and checking bounds
• 🍃 wind calculations calculations
• 💨 turbulence parameters
• 🔢 based on reusable SymPy symbolic mathematics

❓ Why not metpy?

While metpy provides much functionality to handle spatial weather data, it is less focused on timeseries/turbulence analysis such as spectral analysis. See here for a more detailed comparison.

🛠️ Inner Workings

PARMESAN uses...

• SymPy to do the math. PARMESAN derives meteorlogical equations with it and auto-generates Python functions and documentation based SymPy expressions.
• pint to handle physical units.
• pint-pandas to enable handle units in pandas-DataFrames.
• numpy and scipy for the numerics
• rich for pretty terminal output like progress bars
• matplotlib for plotting

📦 Installation

Tagged versions of PARMESAN are available on PyPi. You can install the latest tagged version of PARMESAN via

# make sure you have pip installed
# Debian/Ubuntu:  sudo apt update && sudo apt install python3-pip
# Manjaro/Arch:  sudo pacman -Syu python-pip

# (optional) Then it's good practice to generate a virtual environment:
python3 -m venv parmesan-venv
source parmesan-venv/bin/activate

# Then install PARMESAN
python3 -m pip install -U parmesan

To install the latest development version of PARMESAN directly from GitLab, run

# make sure to have pip installed, see above
python3 -m pip install -U git+https://gitlab.com/tue-umphy/software/parmesan

You may also use our workgroup Arch/Manjaro repository and install the python-parmesan package with your favourite software installer, for example with pacman:

sudo pacman -Syu python-parmesan

📖 Documentation

Documentation can be found here on GitLab.

If you have a question or a problem with PARMESAN, you may open an issue on GitLab.

➕ Contributing to PARMESAN

If you'd like to contribute to PARMESAN, e.g. by adding new features or fixing bugs or just to run the test suite or generate the documentation locally, read the CONTRIBUTING.md-file.