Skip to main content

Python API for the Surface Reactions database on Catalysis-Hub.org

Project description

## Introduction

CatHub provides an interface to the Surface Reactions database on [Catalysis-Hub.org](http://www.catalysis-hub.org).

The module includes a command line interface that can be used to access and upload data. A short guide is given below. We refer to the [catalysis-hub documentation](http://docs.catalysis-hub.org/en/latest/tutorials/upload.html) for details on how to submit data.

## Using the cathub cli

Run cathub, like so

cathub –help

or with any of its sub-commands, like so

cathub reactions –help

## Examples

Querying the Surface Reactions database:

cathub reactions -q reactants=CO -q chemicalComposition=~Pt

cathub publications -q title=~Evolution -q year=2017

Querying atomic structures on Catalysis Hub with ase db:

cathub ase ‘AgSr’ –gui

## Uploading data

Organizing a general folder into a structured folder:

cathub organize <folderame> -a <ads1,ads2> -c <dft-code> -x <xc-functional> -f <facet> -S <crystal structure>

As an alternative to cathub organize - create an empty organized folderstructure for dropping files yourself. First create a template and edit it, then create the folders.

cathub make_folders –create-template <template> cathub make_folders <template>

Reading folders into a local .db file:

cathub folder2db <foldername>

Sending the data to the Catalysis Hub server:

cathub db2server <dbfile>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Cathub-0.1.4.tar.gz (47.5 kB view details)

Uploaded Source

Built Distribution

Cathub-0.1.4-py3-none-any.whl (66.2 kB view details)

Uploaded Python 3

File details

Details for the file Cathub-0.1.4.tar.gz.

File metadata

  • Download URL: Cathub-0.1.4.tar.gz
  • Upload date:
  • Size: 47.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/3.6.5

File hashes

Hashes for Cathub-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d8761a744c605ef6c5aeb2a33ff1d95fb11d41a469e32107d217ba0de47f1fac
MD5 f3d67e5232b80ff6709615441549cd9e
BLAKE2b-256 c4a7595f7477fb19905b8354a2cfaceb46a8c4479b1b72ffe6b4f5e79ddd5335

See more details on using hashes here.

File details

Details for the file Cathub-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: Cathub-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 66.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/3.6.5

File hashes

Hashes for Cathub-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4b316b3a22b02761b8768e3f2f5311470312675323e015c3dd322e1f84f9d601
MD5 c1cefc9ed1f143c5a8f8e7dc3c87714c
BLAKE2b-256 b197f04f6fa02cd845dd348549996b9cffcbf58e864a06a6439be23293fe589b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page