CCTools API Documentation

This is the API reference manual for the CCTools package, which includes TaskVine, Work Queue, Makeflow, Parrot, Chirp and other software.

If you are writing a TaskVine application, start here:

• taskvine.h (C Language Interface)
• taskvine (Python Language Interface)

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

• work_queue.h (C Language Interface)
• work_queue (Python Language 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

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

• chirp_reli.h
• chirp_recursive.h
• chirp_stream.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 Modules

For more information about using and installing CCTools:

• CCTools Software
• CCTools User Manuals