Welcome to Scythe’s documentation!

Scythe is a library of tools that generate summaries of the data contained in scientific data files. The goal of Scythe is to provide a shared resources of these tool to avoid duplication of effort between the many emerging scientific databases. Each extractor is designed to generate the sum of all data needed by each of these databases with a uniform API so that specific projects can write simple adaptors for their needs.

Source Code: https://github.com/materials-data-facility/Scythe

Contents:

• Project Goals
  • What Does Scythe Do?
  • What Does Scythe Not Do?
• User Guide
  • Installing Scythe (for users)
  • Discovering an extractor
  • Simple Interface
  • Class Interface
  • Integrating Scythe into Applications
• Contributor Guide
  • Setting up development environment
  • Step 1: Implement the Extractor
  • Step 2: Document the Extractor
  • Step 3: Register the Extractor
• Available Extractors
  • Quick Summary
  • Detailed Listing
• scythe
  • scythe.adapters.base
  • scythe.utils.interface
  • scythe.utils.grouping