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.3rc2.tar.gz (13.8 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.3rc2-py3-none-any.whl (140.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cif_lsp-1.0.3rc2.tar.gz
  • Upload date:
  • Size: 13.8 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.3rc2.tar.gz
Algorithm Hash digest
SHA256 85e07963faaa9a583ce3b8833c2b83209ceb215396e612850dffa82627370b75
MD5 03137795541fb2ed74ada584796d232d
BLAKE2b-256 b0e2837c043ca12ca52194b106e0efad5e822b2f7ffea65bb8f37275c72273e7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cif_lsp-1.0.3rc2-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.3rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 4f89afde72c4ca784ea803d8dab0f957b67ac8d23ca76b26461ccf0da77b44c9
MD5 1019bdcc8d221ec8bd15a939395263a4
BLAKE2b-256 b01c2178df4f216c7bc54a2caf865898ba3e548d3bc7f9b05de67207f5d22861

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