Skip to content

Commit ecdbb1b

Browse files
authored
Merge pull request #17 from ccdc-opensource/emyers-ccdc-fix-broken-image-links
Fix broken image links NO_JIRA
2 parents 14daf3b + 6178e51 commit ecdbb1b

File tree

1 file changed

+11
-10
lines changed
  • scripts/packing_similarity_dendrogram

1 file changed

+11
-10
lines changed

scripts/packing_similarity_dendrogram/ReadMe.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Packing Similarity Dendrogram
22

3-
## Summary:
3+
## Summary
44

55
This command-line script is designed to compare the packing of a set of input structures of a molecule (polymorphs,
66
co-crystals, solvates, and hydrates). An all-to-all comparison of the structures is performed, considering _only the
77
heaviest components_ in each structure, and a packing-similarity dendrogram or tree is constructed using hierarchical
88
clustering. This dendrogram shows the similarity between groups of structures and how these groups relate to one
99
another.
1010

11-
## Requirements:
11+
## Requirements
1212

1313
CSD Python API (v. 1.0 or later), `matplotlib` and standard python packages.
1414

@@ -18,7 +18,7 @@ CSD Python API (v. 1.0 or later), `matplotlib` and standard python packages.
1818

1919
- CSD-Materials or CSD-Enterprise
2020

21-
## Usage and Output:
21+
## Usage and Output
2222

2323
`python Packing_Similarity_Dendrogram.py -h` will show the help text:
2424

@@ -110,7 +110,7 @@ than an RMSD tolerance). The `-ct` option can therefore be used to specific an R
110110
conformations are matched and in, turn, whether two clusters that have only one molecule in common should be merged at
111111
that level.
112112

113-
## Understanding the Dendrogram:
113+
## Understanding the Dendrogram
114114

115115
An example dendrogram (produced using CBZdataset.ind and related files; see supporting material
116116
of [Cryst. Growth Des., 2009, 9, 1869 __ 1888](https://pubs.acs.org/doi/10.1021/cg801056c) ) is shown below in Figure 1.
@@ -142,11 +142,11 @@ clustering.
142142
If there are dangling nodes without an associated identifier, it is likely that there multiple structures given the same name
143143
in the supplied file (searched through multiple databases say)
144144

145-
![Figure 1](dendogram_figure_1.png)
145+
![Figure 1](assets/dendogram_figure_1.png)
146146
**Figure 1** : Example dendrogram based on a database of carbamazepine solid forms using the default single-linkage
147147
clustering.
148148

149-
![Figure 2](dendogram_figure_2.png)
149+
![Figure 2](assets/dendogram_figure_2.png)
150150
**Figure 2** : Example dendrogram based on a database of carbamazepine solid forms using complete- linkage clustering.
151151

152152
The final option for clustering type is to merge clusters based on their average packing- similarity agreement. The
@@ -156,17 +156,18 @@ values and therefore the plot may become more complex visually.
156156
There are several alternative schemes for linking clusters ( _e.g._ weighting the average based on the cluster sizes)
157157
that could also be implemented.
158158

159-
![Figure 3](dendogram_figure_3.png)
159+
![Figure 3](assets/dendogram_figure_3.png)
160160
**Figure 3** : Example dendrogram based on a database of carbamazepine solid forms linking clusters based on their
161161
average packing similarity.
162162

163-
## Caveats:
163+
## Caveats
164164

165165
The tool considers only the heaviest component in each crystal structure to enable comparison of multi-component forms
166166
with pure forms. Results for _Z_ ’ > 1 systems may not fully reflect differences between structures as the best match is
167167
retained by default in the packing-similarity analysis.
168168

169-
## Authors:
169+
## Authors
170+
170171
_Anthony Reilly_(2016)
171172

172-
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](mailto:support@ccdc.cam.ac.uk)
173+
> For feedback or to report any issues please contact [support@ccdc.cam.ac.uk](mailto:support@ccdc.cam.ac.uk)

0 commit comments

Comments
 (0)