Table of Contents

Module: csd interface/csd.py

Interface to the cambridge structural database (CSD)

Functions   
author
cell
conquest
parse
quest
remprg
  author 
author ( s )

Perform a CSD query for an author name.

parameters:

s

the author name.

  cell 
cell ( cl )

Perform a CSD query for a unit cell.

parameters:

cell

a crystal.Cell() instance

  conquest 
conquest ( name="collect",  list=None )

Run the conquest program on the refcodes listed in list

  parse 
parse ( fn )

Parses the CSD screen output captured in the named file.

Returns an instance of the Hits() class.

Exceptions   
ValueError( "Error running CSD program. Please configure 'csdhome' correctly." )
  quest 
quest (
        s,
        name="collect",
        virtual=None,
        )

Run a non-interactive question to the database.

parameters:

s

the query in the form of a string

name

the name of the project. This is the prefix of all file names that will be used.

virtual

if set to a string should point to a file consisting of a list of REFcodes making up a virtual database.

return value: an instance of the Hits() class.

Exceptions   
ValueError( "CSD has not been configured" )
ValueError( "Error running CSD program. Please configure 'csdhome' correctly." )
  remprg 
remprg ()

Classes   
Hit

Storage of a CSD hit.

Hits

Class behaving a bit like a list of Hit() objects.


Table of Contents

This document was automatically generated on Tue Nov 25 12:18:58 2008 by HappyDoc version WORKING