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 CC-NN [...]      copy examples (number or name) into ./example
  crystod-example CC-NN -o DIR     copy into DIR instead
  crystod-example --all -o DIR     copy every packaged example into DIR

then cd into DIR/CC-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/..., ../CC-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-01_wigner_d                 Wigner D matrices on real spherical harmonics (library API)
01-02_salc                     crystod (SALC: crystal-orbital irreps, hybridization)
01-03_hybridization            crystod (--atomic-orbital hybridization; --diagram crystal-orbital diagrams)
01-04_selection_rules          crystod --diagram (dipole selection rules of the crystal-orbital diagrams)
01-05_star_of_k                crystod --star-of-k
01-06_visualized_basis         crystod --visualize (SALC viewer HTML)
01-11_python_api               the library API (crystod.phonon etc.) on the SrTiO3 data
02-01_direct_product           crystod-group --product / --table (point- and space-group irreps)
02-02_symmetric_square         crystod-group --product --symmetric / --antisymmetric, --jahn-teller
02-03_decompose_irrep          crystod-group --decompose
02-04_ligand_field_split       crystod-group --ligand-field
02-05_basis_function           crystod-group --basis
02-06_tensor_form              crystod-group --tensor (property-tensor forms)
02-07_generate_basis_function  crystod-group --generate-basis
02-08_show_coset               crystod-group --coset
02-09_correlate                crystod-group --correlate (correlation and compatibility of irreps)
02-10_isotropy_subgroup        crystod-group --parent (isotropy subgroups)
02-11_invariants               crystod-group --parent --irrep --invariants (invariant polynomials)
02-12_child_lookup             crystod-group --parent G --child H (reverse lookup)
02-13_subgroup_graph           crystod-group --parent --irrep --graph (group-subgroup graph)
02-14_multiplet                crystod-group --multiplet (spin multiplicities of irrep-shell configurations)
02-15_poscar2cif               crystod-group --poscar2cif / --cif2poscar (POSCAR <-> Bilbao-style CIF)
02-16_symmetry_mode            crystod-group --supergroup-cif (AMPLIMODES-style symmetry-mode analysis)
02-17_correlate_double_group   crystod-group --correlate-double-group (single- to double-valued irreps, spin-orbit coupling)
03-01_brillouin_zone           crystod-bz
03-02_bz_supercell             crystod-bz --trans-mat
04-01_phonon_irrep             crystod-phonon -c POSCAR --element EL --irrep IR [IR2] (displacement pattern of every isotropy subgroup on the atoms of EL, group re-identified from the displaced structure; README transcripts of La3Ni2O7, ScF3 and SrTiO3)
04-02_phonon_bandirrep         crystod-phonon --irreps
04-03_phonon_activity          crystod-phonon --irreps / --vibration (IR / Raman / silent / acoustic activity at Gamma)
04-04_phonon_fatband           crystod-phonon --fatband
04-05_phonon_lt                crystod-phonon --lt
04-06_phonon_vector            crystod-phonon --vector
04-07_modulation               crystod-phonon --modulation
04-08_vibration                crystod-phonon --vibration
04-09_phonon_unfold            crystod-phonon --unfold (phonon band unfolding onto the parent Brillouin zone)
04-10_phonon_visualize         crystod-phonon --visualize (interactive 3D viewer of the phonon modes by irrep)
04-12_phonon_mode_fc           crystod-phonon --mode-resolved-fc (force constant of every phonon mode and irrep-resolved Hessians)
05-01_mag_irrep                crystod-mag -c POSCAR --element EL --irrep IR [IR2] (magnetic arrangement of every magnetic isotropy subgroup on the sites of EL, group re-identified from the structure)
05-02_spin_basis               crystod-mag
05-03_magnetic_group           crystod-mag --classify-only (magnetic space groups, altermagnet classes)
05-06_mag_directions           crystod-mag --qpoint K (order-parameter directions at q != 0: both phases of a complex order parameter, ISOTROPY labels, dir<k>)
05-08_phonon_angular_momentum  crystod-mag --phonon-angular-momentum (phonon angular momentum near GM allowed by the magnetic point group)
05-09_multi_element            crystod-mag --element A B, --superpose (spin bases on several elements, combined arrangements, superpositions)
05-10_mag_coupled              crystod-mag --parent SG --irrep A B (magnetic isotropy subgroups of several coupled irreps; README transcript only)
06-01_xdatcar2adp              crystod-md --adp (and --summary on the same XDATCAR)
06-03_md_projection            crystod-md --project (mode projection of an MD trajectory)
07-01_molecular_salc           crystod-mol (--symmetry and molecular SALCs)
07-02_molod                    crystod-mol --diagram (MO diagrams: symmetry + overlap, or --pyscf)
08-01_xrd_pattern              crystod-xrd (powder X-ray diffraction patterns)
08-02_xrd_superlattice         crystod-xrd --parent / --radiation neutron (superlattice reflections, k points, irreps)
09-01_slab                     crystod-slab (surface slabs, their terminations and polarity)
10-01_mp_search                crystod-search (Materials Project search and POSCAR download; needs an API key)

Examples that read files of other examples (copied together):
  01-11_python_api        04-02_phonon_bandirrep
  04-03_phonon_activity   04-02_phonon_bandirrep 04-04_phonon_fatband
  06-03_md_projection     04-07_modulation 06-01_xdatcar2adp
  08-02_xrd_superlattice  02-16_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
