CrystallographyBase
Documentation for CrystallographyBase.
See the Index for the complete list of documented functions and types.
The code is hosted on GitHub, with some continuous integration services to test its validity.
This repository is created and maintained by singularitti. You are very welcome to contribute.
Installation
The package can be installed with the Julia package manager. From the Julia REPL, type ]
to enter the Pkg REPL mode and run:
pkg> add CrystallographyBase
Or, equivalently, via the Pkg
API:
julia> import Pkg; Pkg.add("CrystallographyBase")
Compatibility
- Julia version:
v1.3
tov1.7
- Dependencies:
Combinatorics.jl
v0.7.0
and aboveCoordinateTransformations.jl
v0.5.1
and aboveCounters.jl
v0.3.0
and aboveEnumX.jl
v1.0.0
and aboveFunctors.jl
v0.1.0
and abovePeriodicTable.jl
v0.1.0
and aboveStaticArrays.jl
v0.8.3
and above
- OS: macOS, Linux, Windows, and FreeBSD
- Architecture: x86, x64, ARM
Documentation
- STABLE — documentation of the most recently tagged version.
- DEV — documentation of the in-development version.
Project Status
The package is tested against, and being developed for, Julia 1.6
and above on Linux, macOS, and Windows.
Questions and Contributions
Usage questions can be posted on our discussion page.
Contributions are very welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems. The contributing page has a few guidelines that should be followed when opening pull requests and contributing code.
Manual Outline
Library Outline
Index
CrystallographyBase.Bravais
CrystallographyBase.CrystalSystem
CrystallographyBase.LatticeSystem
CrystallographyBase.CartesianFromFractional
CrystallographyBase.FractionalFromCartesian
CrystallographyBase.Lattice
CrystallographyBase.MetricTensor
CrystallographyBase.Miller
CrystallographyBase.MillerBravais
CrystallographyBase.MonkhorstPackGrid
CrystallographyBase.PrimitiveFromStandardized
CrystallographyBase.ReciprocalLattice
CrystallographyBase.ReciprocalMiller
CrystallographyBase.ReciprocalMillerBravais
CrystallographyBase.ReciprocalPoint
CrystallographyBase.StandardizedFromPrimitive
CrystallographyBase.cellvolume
CrystallographyBase.coordinates
CrystallographyBase.crystaldensity
CrystallographyBase.directionangle
CrystallographyBase.directioncosine
CrystallographyBase.distance
CrystallographyBase.family
CrystallographyBase.interplanar_spacing
CrystallographyBase.latticeconstants
CrystallographyBase.latticesystem
CrystallographyBase.latticevectors
CrystallographyBase.periodicity
CrystallographyBase.reciprocal
CrystallographyBase.supercell
CrystallographyBase.weights
CrystallographyBase.@m_str