MillerIndices

Documentation for MillerIndices.

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 MillerIndices

Or, equivalently, via the Pkg API:

julia> import Pkg; Pkg.add("MillerIndices")   Resolving package versions...
   Installed MillerIndices ─ v0.1.0
    Updating `~/work/MillerIndices.jl/MillerIndices.jl/docs/build/developers/Project.toml`
  [f41335bc] + MillerIndices v0.1.0
    Updating `~/work/MillerIndices.jl/MillerIndices.jl/docs/build/developers/Manifest.toml`
  [861a8166] + Combinatorics v1.0.2
  [f41335bc] + MillerIndices v0.1.0
  [90137ffa] + StaticArrays v1.6.5
  [1e83bf80] + StaticArraysCore v1.4.2
  [37e2e46d] + LinearAlgebra
  [e66e0078] + CompilerSupportLibraries_jll v1.0.5+0
  [4536629a] + OpenBLAS_jll v0.3.21+4
  [8e850b90] + libblastrampoline_jll v5.8.0+0
Precompiling project...
MillerIndices
  1 dependency successfully precompiled in 1 seconds. 22 already precompiled.
  1 dependency precompiled but a different version is currently loaded. Restart julia to access the new version

Documentation

  • STABLEdocumentation of the most recently tagged version.
  • DEVdocumentation 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