BioSimSpace.IO.formatInfo

BioSimSpace.IO.formatInfo(format)

Return information for the specified file format.

Parameters:

format (str) – The file format.

Returns:

info – A description of the named file format.

Return type:

str

Examples

Display information regarding the PDB format.

>>> import BioSimSpace as BSS
>>> BSS.formatInfo("PDB")

Print information for each of the supported file formats.

>>> import BioSimSpace as BSS
>>> for format in BSS.IO.fileFormats:
...     BSS.IO.formatInfo(format)