{
  "name": "CatHub commands and Python interfaces by workflow role",
  "description": "Compares the command-line subcommands, Python classes and API endpoint documented for the CatHub package, with the role each plays in querying or submitting Catalysis-Hub.org data. Compiled from the package README, PyPI page, upload tutorial and the 2019 Scientific Data paper.",
  "page": "https://casrai.org/guides/cathub",
  "publisher": "CASRAI",
  "license": "https://creativecommons.org/licenses/by/4.0/",
  "dateModified": "2026-11-18T04:04:42Z",
  "temporalCoverage": null,
  "spatialCoverage": null,
  "columns": [
    {
      "name": "Interface item",
      "unit": "",
      "description": ""
    },
    {
      "name": "Kind",
      "unit": "",
      "description": ""
    },
    {
      "name": "Role in the workflow",
      "unit": "",
      "description": ""
    },
    {
      "name": "Documented in",
      "unit": "",
      "description": ""
    }
  ],
  "rows": [
    {
      "Interface item": "cathub ase",
      "Kind": "CLI subcommand",
      "Role in the workflow": "Query the database from the command line, for example 'CuAg pub_id=PengRole2020'",
      "Documented in": "PyPI page; Winther et al. 2019"
    },
    {
      "Interface item": "cathub organize",
      "Kind": "CLI subcommand",
      "Role in the workflow": "Arrange large systematic sets of calculations without barriers or transition states before building a database",
      "Documented in": "Upload tutorial; README"
    },
    {
      "Interface item": "cathub make-folders",
      "Kind": "CLI subcommand",
      "Role in the workflow": "Create an editable template, then the folder structure for a dataset",
      "Documented in": "Upload tutorial; README"
    },
    {
      "Interface item": "cathub folder2db",
      "Kind": "CLI subcommand",
      "Role in the workflow": "Convert a folder of calculations into a local .db file and print a reaction-energy summary",
      "Documented in": "Upload tutorial; README"
    },
    {
      "Interface item": "cathub show-reactions",
      "Kind": "CLI subcommand",
      "Role in the workflow": "Inspect the reactions in a local .db file",
      "Documented in": "README"
    },
    {
      "Interface item": "cathub db2server",
      "Kind": "CLI subcommand",
      "Role in the workflow": "Upload a .db file to the Catalysis-Hub server (SLAC affiliates); others email the file",
      "Documented in": "Upload tutorial; README"
    },
    {
      "Interface item": "CathubSQL",
      "Kind": "Python class",
      "Role in the workflow": "Connect to the online database or open a local .db file",
      "Documented in": "PyPI page"
    },
    {
      "Interface item": "CathubQuery",
      "Kind": "Python class",
      "Role in the workflow": "get_reactions returns a DataFrame; get_dataframe filters by publication, composition and facet",
      "Documented in": "README"
    },
    {
      "Interface item": "api.catalysis-hub.org/graphql",
      "Kind": "GraphQL endpoint",
      "Role in the workflow": "Programmatic queries returning JSON; the README says an API key is required",
      "Documented in": "README; Winther et al. 2019"
    }
  ],
  "sources": [
    {
      "title": "CatHub README (SUNCAT-Center)",
      "url": "https://github.com/SUNCAT-Center/CatHub",
      "accessed": "2026-11-18"
    },
    {
      "title": "Cathub on PyPI",
      "url": "https://pypi.org/project/Cathub/",
      "accessed": "2026-11-17"
    },
    {
      "title": "Catalysis-Hub documentation: uploading data",
      "url": "https://catalysis-hub.readthedocs.io/en/latest/tutorials/upload.html",
      "accessed": "2026-11-17"
    },
    {
      "title": "Winther et al., Catalysis-Hub.org, Scientific Data 6:75",
      "url": "https://pmc.ncbi.nlm.nih.gov/articles/PMC6538711/",
      "accessed": "2026-11-17"
    }
  ]
}