Welcome to urgap

urgap is a node wrapping framework, containing abstraction layers for data and meta data, extensive re-run skipping logic and data versioning. urgap can be incorporated with any scheduling/pipelining tool making pipeline development independent from business logic and data storage, while offering standardized logging and execution, which makes monitoring and debugging easy.

Documentation

Main:

• Getting started
  • Installation (stable version)
• Quickstart
  • Minimal pipeline: download a CSV and filter it
  • Executing example scripts
• Concepts
  • File Identity
  • Provenance as Code (PaC)
  • Standardized Service Interfaces
  • UNode
  • UFiles
  • uctl
• Advanced topics
  • Dashboard
  • UReport
  • Programmatically accessing files using a wid
  • Implementing a new UNode
  • How to use UNodes as remote services
  • How to use Urgap with different orchestration tools
• F.A.Q
• Third party tools
• Example Scripts
  • Tutorial Notebooks
• Writing a UNode
  • UNode Location
  • Choose a Template
  • UNode Structure

Developer:

• API Documentation
  • UCore
  • UConvert Classes
  • UCredentialManager Class
  • UCredentials IO Classes
  • UCtl
  • UFile Class
  • UUriDict Class
  • UFile IO Classes
  • UFileList Class
  • UHelpers Classes
  • UInit
  • UMeta Class
  • UMeta IO Classes
  • UNode Class
  • UNodeManager Class
  • UReport Class
  • URunDict Class
  • UTelemetry Class
  • Util
  • UTrace Class
  • UTree Class
  • UWid Class
• Contributing
  • Contribution Guidelines
• Appendix

The latest Documentation was generated on: Apr 28, 2026