tempestextremes
Extreme weather detection and characterization.
https://github.com/ClimateGlobalChange/tempestextremes
Category: Climate Change
Sub Category: Climate Data Processing and Analysis
Keywords from Contributors
geoscience unstructured-grids ugrid
Last synced: about 10 hours ago
JSON representation
Repository metadata
Extreme weather detection and characterization
- Host: GitHub
- URL: https://github.com/ClimateGlobalChange/tempestextremes
- Owner: ClimateGlobalChange
- Created: 2014-10-03T16:36:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T21:10:26.000Z (28 days ago)
- Last Synced: 2025-04-27T12:36:33.260Z (3 days ago)
- Language: HTML
- Size: 95.9 MB
- Stars: 101
- Watchers: 10
- Forks: 37
- Open Issues: 37
- Releases: 10
-
Metadata Files:
- Readme: README.md
README.md
TempestExtremes
Author: Paul Ullrich
Email: paullrich@ucdavis.edu
Copyright 2025 Paul Ullrich
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Installation via conda
TempestExtremes can be found on conda-forge here:
https://anaconda.org/conda-forge/tempest-extremes
To install from conda use the command line:
conda install -c conda-forge tempest-extremes
Installation via CMake
TempestExtremes can be built and installed on various systems using CMake. Our new script, ./quick_make_unix.sh
, automatically detects your platform(UNIX-based systems only) and loads any required modules before building.
General CMake Configuration
- Install Prefix: Set with
-DCMAKE_INSTALL_PREFIX=PATH_TO_INSTALL
. By default, it installs to the project root, with executables placed inTEMPEST_EXTREMES_SOURCE_DIR/bin
. - Build Type: Specify via
-DCMAKE_BUILD_TYPE=[Release/Debug]
. - MPI Support: Enable or disable using
-DENABLE_MPI=ON
or-DENABLE_MPI=OFF
. - Out-of-Source Build: Build files are generated in
./build/bin
(keeping the source directory clean). - Installation Locations: Final executables are installed to
./bin
and libraries/archives to./lib
.
Quick-Make Scripts for generic Linux/Unix based systems
A ready-to-use ./quick_make_unix.sh
script is available for end users to run on common UNIX-based platforms such as MacOS and Linux, as well as on command HPC systems like NERSC Perlmutter and NCAR Derecho.
quick_make_unix.sh
System/Platforms Detection in - MacOS/Linux (Generic): The script runs the default commands.
- NERSC Perlmutter: The script automatically loads
cray-hdf5
andcray-netcdf
modules before building. - NCAR Derecho: The script loads required modules such as
ncarenv
,ncarcompilers
,intel
,cray-mpich
, andnetcdf
. - Windows: This bash script is prepared for UNIX-like environments. If you're on Windows, please refer to the Windows instructions below. If you have a bash environment on Windows but the script fails to run automatically, simply run the commands manually starting from
./remove_depend.sh
. - Unknown/Other: If your system isn’t recognized or errors occur (often due to non-standard dependency paths), don’t panic—simply run the commands manually starting from
./remove_depend.sh
and fix the related errors shown in the terminal.
Notes:
-
For End Users:
If you only need the final deliverables, run the quick-make script. It will install executables to./bin
and (by default) remove the build directory for a clean structure. -
For Developers:
The./build
directory is used for development and debugging. It contains all intermediate files, which helps speed up incremental builds. Developers should keep the build directory intact (by commenting out the cleanup step) for faster rebuilds.
To use ./quick_make_unix.sh
, update the configuration options in the script:
# Configuration Options
BUILD_TYPE="Release" # "Debug" or "Release"
ENABLE_MPI="ON" # "ON" or "OFF"
OPTIMIZATION_LEVEL="-O3" # Options: "-O0", "-O1", "-O2", "-O3", "-Ofast"
DEBUG_SYMBOLS="OFF" # "ON" to include debug symbols (-g), "OFF" to exclude
INSTALL_PREFIX="" # Specify the installation directory. If left blank, it defaults to
# the project root (TEMPEST_EXTREMES_SOURCE_DIR) and final executables
# will be installed in TEMPEST_EXTREMES_SOURCE_DIR/bin.
The run ./quick_make_unix.sh
.
Unix/Linux-Based Systems (Manual Install)
If you are using Nersc Permultter, you will need to run this first:
module load cray-hdf5
module load cray-netcdf
If you are using NCAR Derecho, you will need to run this first:
module load cmake ncarenv gcc craype cray-mpich hdf5 netcdf
Use the following commands to compile on Unix- or Linux-based systems ):
cd TEMPEST_EXTREMES_SOURCE_DIR
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=[Release/Debug] -DCMAKE_INSTALL_PREFIX=PATH_TO_INSTALL -DCMAKE_PREFIX_PATH=MPI_ROOT ..
make && make install
Windows (Experimental)
Follow these steps to compile on the Windows system (Visual Studio and CMake required):
- Download and install netCDF and Microsoft MPI. Select "Add netCDF to the system PATH for the current user" when instaling netCDF.
- Use the following PowerShell commands to generate a Visual Studio project.
$Env:MSMPI_LIB64="MSMPI_SDK_ROOT/Lib/x64"
$Env:MSMPI_INC="MSMPI_SDK_ROOT/Include"
cd TEMPEST_EXTREMES_SOURCE_DIR
mkdir build
cd build
cmake -G "Visual Studio 17" -DCMAKE_INSTALL_PREFIX=PATH_TO_INSTALL -DNetCDF_ROOT=YOUR_NETCDF_INSTALLATION_PATH ..
- Open the
tempestextremes.sln
file in the./build
directory with Visual Studio and Build the software by clicking "Build" and "Build INSTALL" at the top menu bar. Learn more about building Visual Studio projects.
Developer Notes
-
Using the Quick Make Script:
If you are a developer using./quick_make_general.sh
, remember to comment out or remove the cleanup step at the end (e.g.make clean
). It's not efficient to rebuild the entire project every time you make changes—this script is mainly for a full rebuild or for end users who want a clean install. For faster incremental builds during development, build manually so that intermediate files are preserved. -
Adding New Executables:
To add a new executable to the project, refer to following examples:Example: Adding a New Executable
For example, to addNewBlobsFeature
:- Edit the CMakeLists.txt File:
Open the appropriate file (e.g.,src/blobs/CMakeLists.txt
) and add:add_executable(NewBlobsFeature NewBlobsFeature.cpp) target_link_libraries(NewBlobsFeature PUBLIC extremesbase netcdf_c++ ${MPI_CXX_LIBRARIES})
- Update the Install Rule:
Modify the install command in the same CMakeLists.txt to include the new executable:
This ensures thatinstall( TARGETS BlobStats DetectBlobs PersistentBlobs StitchBlobs NewBlobsFeature RUNTIME DESTINATION bin )
NewBlobsFeature
will be copied to./bin
when you runmake install
.
- Edit the CMakeLists.txt File:
-
Combining Multiple Files into One Executable:
If your new executable requires multiple source files, do the following:Example: Combining Multiple Files into One Executable
For instance, to create an executable namedBlockingUtilities
from multiple files:- Edit the CMakeLists.txt File:
Opensrc/blocking/CMakeLists.txt
and add:list(APPEND BLOCKINGUTILITIES BlockingUtilities.h BlockingUtilities.cpp MoreBlockingUtilities.cpp ) add_executable(BlockingUtilities ${BLOCKINGUTILITIES}) target_link_libraries(BlockingUtilities PUBLIC extremesbase netcdf_c++ ${MPI_CXX_LIBRARIES})
- Update the Install Rule:
Ensure that the new target is included in the install command:install( TARGETS BlockingUtilities RUNTIME DESTINATION bin )
- Edit the CMakeLists.txt File:
By following these guidelines, you can efficiently develop and extend TempestExtremes while keeping a clean separation between the build artifacts and the final deliverables.
Usage
Details of the various executables that are part of TempestExtremes can be found in the user guide:
https://climate.ucdavis.edu/tempestextremes.php
Publications
If you use the TempestExtremes software please cite our publications:
[https://dx.doi.org/10.5194/gmd-14-5023-2021] Ullrich, P.A., C.M. Zarzycki, E.E. McClenny, M.C. Pinheiro, A.M. Stansfield and K.A. Reed (2021) "TempestExtremes v2.1: A community framework for feature detection, tracking and analysis in large datasets" Geosci. Model. Dev. 14, pp. 5023–5048, doi: 10.5194/gmd-14-5023-2021.
[http://dx.doi.org/10.5194/gmd-2016-217] Ullrich, P.A. and C.M. Zarzycki (2017) "TempestExtremes v1.0: A framework for scale-insensitive pointwise feature tracking on unstructured grids" Geosci. Model. Dev. 10, pp. 1069-1090, doi: 10.5194/gmd-10-1069-2017.
[http://dx.doi.org/10.1002/2016GL071606] Zarzycki, C.M. and P.A. Ullrich (2017) "Assessing sensitivities in algorithmic detection of tropical cyclones in climate data" Geophys. Res. Lett. 44 (2), pp. 1141-1149, doi: 10.1002/2016GL071606.
Owner metadata
- Name: ClimateGlobalChange
- Login: ClimateGlobalChange
- Email:
- Kind: organization
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/6710953?v=4
- Repositories: 8
- Last ynced at: 2023-08-17T18:31:24.389Z
- Profile URL: https://github.com/ClimateGlobalChange
GitHub Events
Total
- Create event: 3
- Release event: 2
- Issues event: 11
- Watch event: 22
- Issue comment event: 28
- Push event: 41
- Pull request review event: 3
- Pull request review comment event: 2
- Pull request event: 7
- Fork event: 6
Last Year
- Create event: 3
- Release event: 2
- Issues event: 11
- Watch event: 22
- Issue comment event: 28
- Push event: 41
- Pull request review event: 3
- Pull request review comment event: 2
- Pull request event: 7
- Fork event: 6
Committers metadata
Last synced: 2 days ago
Total Commits: 951
Total Committers: 10
Avg Commits per committer: 95.1
Development Distribution Score (DDS): 0.387
Commits in past year: 73
Committers in past year: 4
Avg Commits per committer in past year: 18.25
Development Distribution Score (DDS) in past year: 0.26
Name | Commits | |
---|---|---|
Paul Ullrich | p****h@u****u | 583 |
mariellep | m****o@g****m | 322 |
Hongyu Chen | h****0@g****m | 20 |
huskychan | h****n | 9 |
Hongyu Chen | h****n@u****u | 9 |
Kyle Stachowicz | k****9@g****m | 3 |
Colin Zarzycki | z****i@u****u | 2 |
Stephan Hoyer | s****r@g****m | 1 |
Kian Huang | k****g@k****m | 1 |
Marielle Cristine Pinheiro | m****i@f****u | 1 |
Committer domains:
- ucdavis.edu: 2
- farm.cse.ucdavis.edu: 1
- kimeow.com: 1
- google.com: 1
- ucar.edu: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 89
Total pull requests: 12
Average time to close issues: 2 months
Average time to close pull requests: 3 months
Total issue authors: 26
Total pull request authors: 6
Average comments per issue: 1.98
Average comments per pull request: 0.67
Merged pull request: 9
Bot issues: 0
Bot pull requests: 0
Past year issues: 23
Past year pull requests: 7
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 16 days
Past year issue authors: 13
Past year pull request authors: 4
Past year average comments per issue: 1.96
Past year average comments per pull request: 0.86
Past year merged pull request: 4
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- zarzycki (30)
- yepkids (8)
- wreckdump (7)
- krober10nd (7)
- paullric (6)
- stella-bourdin (4)
- mariellep (3)
- ncubukcu (3)
- onnyyonn (2)
- alyssa-stansfield (2)
- Xiaoning-Wu (2)
- beekill95 (1)
- KianHuangKimeow (1)
- weathermanbarnes (1)
- xiaohumengdie (1)
Top Pull Request Authors
- hongyuchen1030 (4)
- paullric (3)
- zarzycki (2)
- shoyer (1)
- yepkids (1)
- KianHuangKimeow (1)
Top Issue Labels
- bug (4)
- enhancement (1)
Top Pull Request Labels
Package metadata
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
conda-forge.org: tempest-extremes
TempestExtremes is a growing collection of detection and characterization algorithms for large climate datasets, leveraging C++ for rapid throughput and a command line interface that maximizes flexibility of each kernel. The tracking kernels in this package have been already used for tracking and characterizing tropical cyclones (TCs), extratropical cyclones (ETCs), monsoonal depressions, atmospheric blocks, atmospheric rivers, and mesoscale convective systems (MCSs). By considering multiple extremes within the same framework, we can study the joint characteristics of extremes while minimizing the total data burden.
- Homepage: https://github.com/ClimateGlobalChange/tempestextremes
- Licenses: BSD-2-Clause
- Latest release: 2.2.1 (published over 3 years ago)
- Last Synced: 2025-04-29T13:34:24.601Z (1 day ago)
- Versions: 4
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Forks count: 33.247%
- Dependent repos count: 34.025%
- Stargazers count: 38.577%
- Average: 39.256%
- Dependent packages count: 51.175%
Score: -Infinity