CIF_COD_NUMBERS(1)

πŸ“¦
version 3.12.0 Β· 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ¦‹ CIF_COD_NUMBERS β€” bestie's guide to finding COD numbers πŸ’–

okay so first things first: this is the General Commands Manual page for the command cif_cod_numbers, section 1. It's a lil' tool that goes and hunts down COD numbers for the CIF files chilling in whatever directories or file lists you hand it. No cap, that's the whole job. 🌸


✨ NAME ✨

cif_cod_numbers β€” find COD numbers for the CIF files in given directories of file lists.

it's giving "matchmaker but for crystallography files" fr fr πŸ’…


🌈 SYNOPSIS 🌈

so you pass it your options and then a bunch of CIF files (globs are very much invited to the party) πŸŽ€


πŸ’œ DESCRIPTION πŸ’œ

Find COD numbers for the CIF files in given directories of file lists. That's it, that's the vibe. You feed it files, it goes and asks the COD database who these structures actually are. πŸ‘‘


πŸŽ€ OPTIONS πŸŽ€

  • --platform 'SQLite' β€” use the SQL database platform 'SQLite' to query structures (default: 'mysql'). pick your fighter ✨
  • -d, --database β€” use database "cod" to query for structures.
  • -h, --host β€” the host value is www.crystallography.net πŸ’–
  • -s, --server β€” query the COD database on the host 'www.crystallography.net'. yes bestie, that's the default host, iconic behavior 🫢
  • -l, --localhost β€” use the database server on the localhost to query the COD database. stay home, query local 🏠
  • -p, --port β€” use the specified port to query structures (default: 3306). the value shown is 3306, so that's the port you're knocking on πŸ”₯
  • -t, --table β€” use SQL table "data" to query for structures.
  • -u, --user β€” use user name "cod_reader" to access the COD database. This user should have at least the SELECT privilege, i.e. should be able to read the COD database without supplying a password. lowkey the chillest login ever 🧚
  • --password β€” use the specified password to connect (default: ''). empty string, mind you β€” that's the default, not a secret πŸ’€
  • -P, --print-datablock-name β€” print the data block name as the fifth column. extra column, extra drama πŸ“Š
  • -P-, --no-print-datablock-name, --dont-print-datablock-name β€” do not print data block names (this is the default). no datablock names, we're being mysterious πŸ™ˆ
  • -S, --series β€” check only COD entries starting with 9 (the so called 9* series). Default: check the whole COD database. Set series to "" (empty string) to restore the default behaviour. so if you set it to 9, you're only looking at the 9* girlies ⭐
  • --max-cell-length-difference β€” maximum difference of unit cell lengths allowed for entries regarded as the same, in angstroms (default: 0.5). the value shown is 0.5 πŸ“
  • --max-cell-angle-difference β€” maximum difference of unit cell angles allowed for entries regarded as the same, in angstroms (default: 1.2). yep, it says angstroms, we're just reporting what the page says πŸ’… the value shown is 1.2 πŸ“
  • --check-bibliography β€” only CIFs that have different bibliography data are declared different if all other parameters match. CIFs with missing bibliographies are assumed to have matching bibliographies (this is the default). citations matter, bestie πŸ“š
  • --no-check-bibliography, --dont-check-bibliography β€” ignore bibliographic data of all CIFs; thus even files with different bibliographies will be regarded the same if their cells, chemical formulae and measurement conditions match. bibliography? never heard of her πŸ™ˆ
  • --use-sigma, --no-ignore-sigma, --dont-ignore-sigma β€” use standard deviations (sigmas) when comparing unit cell constants (this is the default). respect the sigma ✨
  • --no-use-sigma, --dont-use-sigma, --ignore-sigma β€” ignore standard deviations (sigmas) when comparing unit cell constants. sigma? blocked 🚫
  • --check-sample-history β€” only CIFs that have different sample history data (as recorded in the _exptl_crystal_thermal_history and _exptl_crystal_pressure_history tags) are declared different if all other parameters match. the lore is in the tags, iykyk 🧚
  • --no-check-sample-history, --dont-check-sample-history, --disregard-sample-history β€” ignore sample history of all CIFs; thus even files with different sample histories will be regarded the same if their cells, chemical formulae and measurement conditions match (this is the default). sample history? we don't know her πŸ’€
  • --check-compound-source β€” only CIFs that have different compound source (as recorded in the _chemical_compound_source) are declared different if all other parameters match. where did this compound come from? we're asking πŸ“
  • --no-check-compound-source, --dont-check-compound-source, --disregard-compound-source β€” ignore compound source of all CIFs; thus even files with different compound sources will be regarded the same if other conditions match (this is the default). origin story: deleted 🫢
  • --use-attached-hydrogens β€” include the number of implicit hydrogens, specified using the _atom_site_attached_hydrogens tag, into the formula sum (this is the default). hydrogens are literally invited to the function πŸ”₯
  • --no-use-attached-hydrogens, --dont-use-attached-hydrogens, --ignore-attached-hydrogens β€” ignore the number of implicit hydrogens, specified using the _atom_site_attached_hydrogens tag, in calculation of the formula sum. hydrogens? not counted, not today 😭
  • --use-perl-parser β€” use the Perl-only CIF parser. old reliable, in Perl πŸͺ
  • --use-c-parser β€” use the speed-optimised C/Perl parser (this is the default). fast mode, main character energy ⚑
  • --cif-input β€” use CIF format for input (this is the default). πŸ“„
  • --json-input β€” use JSON format for input. 🧾
  • --help, --usage β€” output a short usage message (this message) and exit. your lil' cheat sheet πŸ’–
  • --version β€” output version information and exit. πŸ‘‘

🫢 REPORTING BUGS 🫢

found a bug? not the vibe. report cif_cod_numbers bugs using e-mail: cod-bugs@ibt.lt πŸ“§


and that's the whole page, bestie!! we made it through every single option, no skips, no cap πŸ’– this was the cif_cod_numbers manual page, from the General Commands Manual (section 1), footer signed CIF_COD_NUMBERS(1) β€” so if you ever see that name floatin' around, it's us. slay, go match some structures βœ¨πŸ‘‘πŸŒΈ

πŸ“¦ where this page comes from