File: compound.md

package info (click to toggle)
python-pubchempy 1.0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 648 kB
  • sloc: python: 1,619; makefile: 13; sh: 5
file content (48 lines) | stat: -rw-r--r-- 1,898 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
(compound)=

# Compounds

The {func}`~pubchempy.get_compounds` function returns a list of {class}`~pubchempy.Compound` objects. You can also instantiate a {class}`~pubchempy.Compound` object directly if you know its CID:

```python
c = pcp.Compound.from_cid(6819)
```

## Dictionary representation

Each {class}`~pubchempy.Compound` has a `record` property, which is a dictionary that contains the all the information about the compound, produced exactly from the JSON response from the PubChem API. All other properties are derived from this record.

Additionally, each {class}`~pubchempy.Compound` provides a {meth}`~pubchempy.Compound.to_dict` method that returns PubChemPy's own dictionary representation of the Compound data. As well as being more concisely formatted than the raw `record`, this method also takes an optional parameter to filter the list of the desired properties:

```pycon
>>> c = pcp.Compound.from_cid(962)
>>> c.to_dict(properties=["atoms", "bonds", "inchi"])
{'atoms': [{'aid': 1, 'element': 'o', 'x': 2.5369, 'y': -0.155},
           {'aid': 2, 'element': 'h', 'x': 3.0739, 'y': 0.155},
           {'aid': 3, 'element': 'h', 'x': 2, 'y': 0.155}],
 'bonds': [{'aid1': 1, 'aid2': 2, 'order': 'single'},
           {'aid1': 1, 'aid2': 3, 'order': 'single'}],
 'inchi': u'InChI=1S/H2O/h1H2'}
```

## 3D compounds

By default, compounds are returned with 2D coordinates. Use the `record_type` keyword argument to specify otherwise:

```python
pcp.get_compounds("Aspirin", "name", record_type="3d")
```

Many properties are missing from 3D records, and the following properties are *only* available on 3D records:

- `volume_3d`
- `multipoles_3d`
- `conformer_rmsd_3d`
- `effective_rotor_count_3d`
- `pharmacophore_features_3d`
- `mmff94_partial_charges_3d`
- `mmff94_energy_3d`
- `conformer_id_3d`
- `shape_selfoverlap_3d`
- `feature_selfoverlap_3d`
- `shape_fingerprint_3d`