Chiltepin Documentation

Chiltepin is a Python library for exploring federated workflow capabilities using Parsl and Globus Compute. It provides tools and demonstrations for implementing distributed scientific workflows on HPC systems.

Warning

This project is for research and exploration purposes only. It is not intended for use in operational production environments.

Platform Support

Chiltepin is developed and tested on Linux:

• ✅ Linux: Full support for all features

• 🍎 macOS: Task submission and data transfer supported (endpoint management not available)

• ❌ Windows: Not supported natively due to reliance on POSIX fork semantics (use Docker or WSL2)

• 🐳 Docker: Full support available via container on all platforms

Note

Windows users can use Chiltepin via Docker container or WSL2 with a Linux distribution. Chiltepin and its use of Parsl both require fork-based multiprocessing which is not available on native Windows.

Overview

This repository is a collection of tools and demonstrations used for implementing distributed exascale scientific workflows. The project focuses on:

• Workflow management using Parsl

• Federated distributed computing with Globus Compute

• HPC integration of multiple on-prem and/or cloud-based systems

• Container-based testing with Docker and Slurm

Key Features

• Configuration-based resource management for both HPC platforms and laptops

• Support for both MPI (HPC) and non-MPI (HTC) applications

• Globus Compute endpoint management utilities

• Task decorators for seamless integration of Parsl and Globus Compute

• Dynamic distributed task execution across heterogeneous resources

• Docker container environment for development and testing

• Comprehensive test suite with high coverage for core modules

Getting Started

• Installation
  • Prerequisites
  • Installing from PyPI
  • Development Installation
  • Activating the Environment
  • Dependencies
• Quick Start
  • Overview
  • Prerequisites
  • Complete Workflow Example
  • Local-Only Quickstart
  • Working with MPI Tasks
  • Key Concepts
  • Directory Structure
  • Troubleshooting
  • Next Steps
• Tasks
  • Overview
  • Python Tasks
  • Bash Tasks
  • MPI Tasks and Task Geometry
  • Join Tasks
  • Tasks as Class Methods
  • Specifying Resources
  • Futures and Results
  • File and Data Handling
  • Advanced Topics
  • Best Practices
  • Common Patterns
  • See Also
• Data Transfer and Management
  • Overview
  • Data Transfer Task
  • Data Deletion Task
  • Workflow Integration
  • Authentication
  • Setting Up Data Endpoints
  • Best Practices
  • Troubleshooting
  • See Also
• Configuration
  • Overview
  • Basic Structure
  • Understanding Resource Configuration
  • Resource Types
  • Configuration Options
  • Example Configurations
  • Loading Configurations
  • Configuration Best Practices
  • See Also
• Endpoint Management
  • Overview
  • The chiltepin Command
  • Authentication
  • Endpoint Commands
  • Endpoint Lifecycle
  • User Endpoint Configuration
  • Troubleshooting
  • Python API
  • See Also
• Testing
  • Prerequisites
  • Globus Authentication
  • Platform-Specific Testing
  • Running Tests
  • Coverage Reports
  • Test Organization
  • Docker Container Testing
• Docker Container
  • Prerequisites
  • Building the Container
  • Accessing the Container
  • Installing Chiltepin in the Container
  • Running Tests in the Container
  • Adjusting Core Count
  • Container Architecture
  • Stopping the Container
  • Troubleshooting

API Reference

• API Reference
  • Configuration Module
  • Workflow Module
  • Endpoint Management Module
  • Tasks Module
  • Data Module
  • Command-Line Interface

Legal Notice

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.