Skip to content

Commit 8cc6a94

Browse files
authored
Merge pull request #96 from SchrodingersCattt/add-disorder-workflow-demo
feat: add disorder-aware CIF export demo
2 parents fc81482 + a5b4740 commit 8cc6a94

2 files changed

Lines changed: 405 additions & 0 deletions

File tree

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Disorder Workflow Demo
2+
3+
## Summary
4+
5+
Exports a CSD entry to a manually assembled CIF that preserves atom-site occupancy,
6+
disorder assembly/group annotations, anisotropic displacement parameters, and bond
7+
connectivity.
8+
9+
This example demonstrates a workflow that is not covered by the built-in CIF writers:
10+
reading a disordered entry from the CSD Python API and reconstructing a CIF with
11+
explicit `_atom_site_occupancy`, `_atom_site_disorder_assembly`, and
12+
`_atom_site_disorder_group` fields.
13+
14+
Example output:
15+
16+
```text
17+
Licence requirement: CSD-Materials or another licence tier with CSD Python API database access
18+
Exported ABACIR -> output/ABACIR.cif (atoms=148, partial_occ=16, bonds=154)
19+
Exported ABABUB -> output/ABABUB.cif (atoms=84, partial_occ=8, bonds=88)
20+
```
21+
22+
## Requirements
23+
24+
- CSD Python API with database access
25+
- Python 3.10+
26+
27+
## Licensing Requirements
28+
29+
CSD-Materials or another licence tier that provides access to the CSD Python API and CSD database.
30+
31+
## Instructions on Running
32+
33+
```bash
34+
python demo_csd_disorder_workflow.py --refcodes ABACIR ABABUB --output-dir ./output
35+
```
36+
37+
Arguments:
38+
39+
- `--refcodes`: one or more CSD refcodes
40+
- `--output-dir`: destination directory for exported CIF files
41+
42+
## Author
43+
44+
Ming-Yu Guo (2026-06-29)
45+
46+
> 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)