cryspy_editor
Editor for CrysPy library
Start
cryspy-editor # opens the last used file
cryspy-editor path/file.rcif # opens the given file
python -m cryspy_editor path/file.rcif
Other programs (for example PyColl5) can open a file in CrysPy Editor the same way. Recent files are in File → Open recent.
Settings are kept in settings.json in the user's folder:
%APPDATA%\CrysPyEditor on Windows, ~/Library/Application Support/CrysPyEditor
on macOS, ~/.config/cryspy_editor on Linux. Settings of older versions are
moved there at the first start.
AI assistant (optional)
CrysPy Editor can use a local language model to answer questions and work
on the opened file. The model runs on your computer; nothing is sent to the
internet. It calls the tools of CrysPy (cryspy.assistant_tools()): help
lookup, list / refine / fix / set parameters by their paths, calculate,
refine, show the model, add an atom, run CrysPy procedures. Questions such as
"how to describe multipoles?" or "what should be used for thermal
vibrations?" are answered from the help pages of CrysPy, which are shown in
the answer. The same help is in Options → CrysPy help... (F1) without a
model.
The assistant works in its own window, AI Assistant / CrysPy Editor, opened by AI assistant → Show assistant. One request may hold several actions (e.g. "fix everything, refine the cell and run the refinement"); a call with wrong arguments goes back to the model to be corrected, and questions are answered from the results of the actions. The window and the logic are the same as in the assistant of PyColl5; only the actions differ.
-
Install the optional dependency:
pip install cryspy_editor[ai](orpip install llama-cpp-python). -
Download once any instruct (chat) model in GGUF format, Q4_K_M quantization. The file should take no more than half of the memory:
Memory Model Q4_K_M file < 8 GB Qwen2.5-1.5B-Instruct 1 GB 8 GB Qwen2.5-3B-Instruct, Llama-3.2-3B-Instruct 2 GB 16 GB Llama-3.1-8B-Instruct, Qwen2.5-7B-Instruct 5 GB 32 GB and more Qwen2.5-14B-Instruct 9 GB -
In CrysPy Editor choose AI assistant → Load local model (*.gguf)..., pick the file and, if needed, the threads, GPU layers, context size, answer length and temperature. The same table is shown there, with the row for your computer in bold. The model is loaded in the background and is loaded again at the next start, until Unload model; the window opens again at the next start if it was open when the program was closed.
Development
mainholds releases,developis the integration branch. Branch offdevelopand open pull requests intodevelop.- Every pull request needs one label:
[scope] bug,[scope] enhancement,[scope] documentation,[scope] maintenanceor[scope] significant. The label decides the next version in the release draft. - The version comes from git tags (plain, e.g.
1.9.10) via versioningit. - Tests:
pip install -e .[dev], thenpython -m pytest. Qt runs without a display in tests (QT_QPA_PLATFORM=offscreen).
1 maintainer
Metadata
1 maintainer
Release files for cryspy-editor 1.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cryspy_editor-1.10.0.tar.gz | 8.1 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cryspy_editor-1.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.2 MB
Release files / cryspy_editor-1.10.0.tar.gz
| Download URL | cryspy_editor-1.10.0.tar.gz |
|---|---|
| Size | 8.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
24c23d811c7587ce23bd760f5409522efe9f48b2da323857dea0de02e79deb7b
|
|
BLAKE2b-256 checksum How to use checksums |
776eef828316eca44672ae38d024031834e8d163b835f62897166f28425f4939
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / cryspy_editor-1.10.0-py3-none-any.whl
| Download URL | cryspy_editor-1.10.0-py3-none-any.whl |
|---|---|
| Size | 8.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
63129e30ba4b14d5961b3dc9f20ead880d71651d7b9eee6767764ba01188dfb4
|
|
BLAKE2b-256 checksum How to use checksums |
83507db815ae3c848688bee08f2fe0c657bc84d40895ef071819f67ab93230da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for cryspy-editor 1.10.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
