CrystOD example directories (packaged copy)

These are the worked examples of CrystOD, installed with the package so that
they are available without cloning the repository.  Do not run them here:
their commands write output files next to the inputs.  Copy them into a
working directory first:

  crystod-example                  list the packaged examples
  crystod-example NN [NN ...]      copy examples (number or name) into ./example
  crystod-example NN -o DIR        copy into DIR instead
  crystod-example --all -o DIR     copy every packaged example into DIR

then cd into DIR/NN_name and follow its README.  The shared directories
test_POSCARs/ and test_XYZs/ are copied along with every example, and an
example that reads files of other examples brings those along, so the relative
paths in the READMEs (../test_POSCARs/..., ../NN_name/...) work in the copy.

Every file in the example and shared directories listed below is a
byte-for-byte copy of the same path under example/ of the CrystOD source tree;
only this README and index.json are generated (by
script/sync_packaged_examples.py).  Some data of example/ is not in the pip
package: large data (force-constant files, full MD trajectories), generated
HTML and PDF output, the reference data of the test suite, and the data of
work not yet published (unpublished, not distributed).  It stays in the
CrystOD development tree; the test suite and development need a clone of the
repository.

Examples
--------
01_wigner_d                  Wigner D matrices on real spherical harmonics (library API)
02_salc                      crystod (SALC: crystal-orbital irreps, hybridization)
03_hybridization             crystod (--atomic-orbital hybridization; --diagram crystal-orbital diagrams)
04_selection_rules           crystod --diagram (dipole selection rules of the crystal-orbital diagrams)
05_star_of_k                 crystod --star-of-k
06_visualized_basis          crystod --visualize (SALC viewer HTML)
11_direct_product            crystod-group --product / --table (point- and space-group irreps)
12_symmetric_square          crystod-group --product --symmetric / --antisymmetric, --jahn-teller
13_decompose_irrep           crystod-group --decompose
14_ligand_field_split        crystod-group --ligand-field
15_basis_function            crystod-group --basis
16_tensor_form               crystod-group --tensor (property-tensor forms)
17_generate_basis_function   crystod-group --generate-basis
18_show_coset                crystod-group --coset
19_correlate                 crystod-group --correlate (correlation and compatibility of irreps)
20_isotropy_subgroup         crystod-group --parent (isotropy subgroups)
21_invariants                crystod-group --parent --irrep --invariants (invariant polynomials)
22_child_lookup              crystod-group --parent G --child H (reverse lookup)
23_subgroup_graph            crystod-group --parent --irrep --graph (group-subgroup graph)
24_multiplet                 crystod-group --multiplet (spin multiplicities of irrep-shell configurations)
25_poscar2cif                crystod-group --poscar2cif / --cif2poscar (POSCAR <-> Bilbao-style CIF)
26_symmetry_mode             crystod-group --supergroup-cif (AMPLIMODES-style symmetry-mode analysis)
27_correlate_double_group    crystod-group --correlate-double-group (single- to double-valued irreps, spin-orbit coupling)
29_brillouin_zone            crystod-bz
30_bz_supercell              crystod-bz --trans-mat
32_phonon_irrep              crystod-phonon --irreps
33_phonon_activity           crystod-phonon --irreps / --vibration (IR / Raman / silent / acoustic activity at Gamma)
34_phonon_fatband            crystod-phonon --fatband
35_phonon_lt                 crystod-phonon --lt
36_phonon_vector             crystod-phonon --vector
37_modulation                crystod-phonon --modulation
38_vibration                 crystod-phonon --vibration
39_phonon_unfold             crystod-phonon --unfold (phonon band unfolding onto the parent Brillouin zone)
40_phonon_visualize          crystod-phonon --visualize (interactive 3D viewer of the phonon modes by irrep)
42_spin_basis                crystod-mag
43_magnetic_group            crystod-mag --classify-only (magnetic space groups, altermagnet classes)
46_xdatcar2adp               crystod-md --adp (and --summary on the same XDATCAR)
47_md_projection             crystod-md --project (mode projection of an MD trajectory)
49_molecular_salc            crystod-mol (--symmetry and molecular SALCs)
50_molod                     crystod-mol --diagram (MO diagrams: symmetry + overlap, or --pyscf)
52_python_api                the library API (crystod.phonon etc.) on the SrTiO3 data
53_xrd_pattern               crystod-xrd (powder X-ray diffraction patterns)
54_xrd_superlattice          crystod-xrd --parent / --radiation neutron (superlattice reflections, k points, irreps)
55_mp_search                 crystod-search (Materials Project search and POSCAR download; needs an API key)
56_slab                      crystod-slab (surface slabs, their terminations and polarity)

Examples that read files of other examples (copied together):
  33_phonon_activity   32_phonon_irrep 34_phonon_fatband
  47_md_projection     37_modulation 46_xdatcar2adp
  52_python_api        32_phonon_irrep
  54_xrd_superlattice  26_symmetry_mode

Shared directories
------------------
test_POSCARs                 shared input structures used by the examples and testsuite
test_XYZs                    shared molecule files (O2, H2O, NH3, CH4, SF6) for crystod-mol
