CCTools API Documentation

This is the API reference manual for the CCTools package, which includes TaskVine, Work Queue, Makeflow, Parrot, Chirp and other software. This provides detailed documentation of programming the libraries in Python and C. For a more general introduction to the software and how to use it from the command line, please see the CCTools Manual

If you are writing a TaskVine application, start here:

- ndcctools::taskvine (TaskVine Python Interface)
- taskvine.h (TaskVine C Interface)

If you are writing a Work Queue application, start here:

- ndcctools::work_queue (Work Queue Python Interface)
- work_queue.h (Work Queue C Interface)

If you are writing a programs to access the Chirp filesystem, start here:

- ndcctools::chirp (Chirp Python Interface)
- chirp_reli.h (Chirp C Interface)

If you are writing a program to submit jobs to arbitrary batch systems, including Work Queue, HTCondor, Amazon EC2, etc. start here:

- batch_job.h

Throughout the CCTools packages, there are a number of other support modules that implement debugging, communication, and data structures. The most commonly used are:

- Data Structures:
  - list.h
  - hash_table.h
  - itable.h
- Networking:
  - link.h (i.e. a TCP connection)
  - datagram.h (i.e. a UDP endpoint)
  - domain_name_cache.h
- JSON Parsing/Printing
  - jx.h
  - jx_print.h
  - jx_parse.h
- Miscellaneous
  - debug.h
  - copy_stream.h
  - copy_tree.h

Or, you can browse all documented modules in the package:

- See All C Files
- See All Python Namespaces