Documentation for CrystallographyCore.

See the Index for the complete list of documented functions and types.

The code, which is hosted on GitHub, is tested using various continuous integration services for its validity.

This repository is created and maintained by @singularitti, and contributions are highly welcome.

Package features


The package can be installed with the Julia package manager. From the Julia REPL, type ] to enter the Pkg mode and run:

pkg> add CrystallographyCore

Or, equivalently, via Pkg.jl:

julia> import Pkg; Pkg.add("CrystallographyCore")   Resolving package versions...
   Installed CrystallographyCore ─ v0.6.2
    Updating `~/work/CrystallographyCore.jl/CrystallographyCore.jl/docs/Project.toml`
  [80545937] ~ CrystallographyCore v0.6.3 `~/.julia/dev/CrystallographyCore` ⇒ v0.6.2
    Updating `~/work/CrystallographyCore.jl/CrystallographyCore.jl/docs/Manifest.toml`
  [80545937] ~ CrystallographyCore v0.6.3 `~/.julia/dev/CrystallographyCore` ⇒ v0.6.2
Precompiling project...
CrystallographyCore → UnitfulExt
  2 dependencies successfully precompiled in 2 seconds. 30 already precompiled.
  2 dependencies precompiled but different versions are currently loaded. Restart julia to access the new versions


  • STABLEdocumentation of the most recently tagged version.
  • DEVdocumentation of the in-development version.

Project status

The package is developed for and tested against Julia v1.6 and above on Linux, macOS, and Windows.

Questions and contributions

You can post usage questions on our discussion page.

We welcome contributions, feature requests, and suggestions. If you encounter any problems, please open an issue. The Contributing page has a few guidelines that should be followed when opening pull requests and contributing code.

Manual outline

Library outline