Skip to main content

Language Server Protocol and agent CLI for CIF files

Project description

CIF for Visual Studio Code

This extension adds support for CIF (Crystallographic Information File) to VS Code.

Features

  • Syntax highlighting
  • Completion and validation for names
  • Hover over value to see corresponding _key and data_.

Setting: Disable Non-Standard Data Name Warnings

By default, CIF validation shows warnings for data names (tags) that are not defined in the currently loaded CIF dictionaries.

If you prefer not to see these warnings, you can disable them in settings:

  1. Open Settings by holding Ctrl (or Cmd on Mac) and pressing , (comma key)
  2. Search for "CIF: Warn On Non Standard Data Names"
  3. Uncheck the option to disable warnings

CIF Dictionaries

This software uses CIF dictionaries provided by the International Union of Crystallography (IUCr), available at https://www.iucr.org/resources/cif/dictionaries.

You can load additional dictionaries manually using the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

Available commands

  • CIF: Add Dictionary Select and load a dictionary file from your local system.

  • CIF: Show Loaded Dictionaries Displays the list of currently active CIF dictionaries.

  • CIF: Remove Dictionary Unload a previously added dictionary.

Technical Details

If you want to build the program yourself or better understand how it works, see the docs/ directory.

Contact

For enquiries related to the development of this extension, or to provide suggestions or feedback, please contact Dr Kaisa Helttunen.

References

This extension has been described in the following publication:

Helttunen, K. & Kainulainen, H. (2025). CIF extension for Visual Studio Code. J. Appl. Cryst. 58, 1469-1475.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cif_lsp-1.0.3rc1.tar.gz (13.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cif_lsp-1.0.3rc1-py3-none-any.whl (140.8 kB view details)

Uploaded Python 3

File details

Details for the file cif_lsp-1.0.3rc1.tar.gz.

File metadata

  • Download URL: cif_lsp-1.0.3rc1.tar.gz
  • Upload date:
  • Size: 13.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for cif_lsp-1.0.3rc1.tar.gz
Algorithm Hash digest
SHA256 42688f2facf17f70c3f0006781ec1212274af668661a97dbe7d2e3fbf20d5f8e
MD5 c5a184d8aeac5fcc25fefc3f4af9619e
BLAKE2b-256 40ec25b0bb742f3c9e681e86906cd64c4e1c7950f93f73dc3ebfbf6d98ed5395

See more details on using hashes here.

File details

Details for the file cif_lsp-1.0.3rc1-py3-none-any.whl.

File metadata

  • Download URL: cif_lsp-1.0.3rc1-py3-none-any.whl
  • Upload date:
  • Size: 140.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for cif_lsp-1.0.3rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 a7b0297e76dcde2fdf338fab6cf191c0440cb5eea1df6041ecfeef545457f2ab
MD5 b4e6ce08c6eea766e5c89918854ae37d
BLAKE2b-256 f2304a450315659cb1254e80a84479d15a84e9928a78f48517c2290681d285d4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page