chiltepin 0.1.6

Federated NWP Workflow Tools

Chiltepin

Overview

This repository is a collection of tools and demonstrations used to explore and test various technologies for implementing exascale scientific workflows. This collection of resources is not intended for production use, and is for research purposes only.

Chiltepin provides Python decorators and utilities for building scientific workflows that can execute on distributed computing resources using Parsl, Globus services, and Academy Agents. It supports both traditional task-based workflows and stateful agent-based workflows for long-running, autonomous computations.

Platform Support

Chiltepin is developed and tested on Linux:

• ✅ Linux: Full support for all features
• 🍎 macOS: Supported for task submission and data transfer (endpoint management not available)
• ❌ Windows: Native execution not supported; Chiltepin's use of Parsl relies on fork-based multiprocessing
• 🐳 Docker: Full Linux-based test suite and feature support available via container on all platforms

Documentation

📚 Full documentation is available at Read the Docs

Key documentation sections:

• Installation Guide - Installing Chiltepin
• Quick Start - Your first Chiltepin workflow
• Tasks - Python, Bash, and Join task decorators
• Agents - Building stateful agent-based workflows
• Configuration - Configuring compute resources
• Endpoints - Managing Globus Compute endpoints
• Data Transfer - Using Globus for data movement
• Testing Guide - Running the test suite

Quick Start

Install Chiltepin using pip:

pip install chiltepin

For detailed installation instructions including conda, Docker, and platform-specific guidance, see the Installation Guide.

Contributing

Contributions are welcome! For development installation and running tests, clone the repository and install in editable mode:

git clone https://github.com/NOAA-GSL/chiltepin.git
cd chiltepin
python -m venv .chiltepin
source .chiltepin/bin/activate
pip install -e ".[test]"

See the Testing Guide for more information.

License

See LICENSE for details.

NOAA Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.