Skip to content

janattig/LatticePhysics.jl

Repository files navigation

LatticePhysics.jl logo

Lattice based calculations and plotting for Julia v.1.0.*

Usage

To use the lattice library in your code, install it as specified below. To use it in your code, start by importing the library

julia> using LatticePhysics

For tutorials and examples, see the LatticePhysics Tutorials repository.

Installation

You can install the package via the package mode in Julia (Pkg). However, since the package is not listed in the Julia package repositories, you have to first install the unregistered dependencies manually with

(v1.0) pkg> add "https://github.com/janattig/LatPhysBase.jl"
(v1.0) pkg> add "https://github.com/janattig/LatPhysUnitcellLibrary.jl"
(v1.0) pkg> add "https://github.com/janattig/LatPhysLatticeConstruction.jl"
(v1.0) pkg> add "https://github.com/janattig/LatPhysLatticeModification.jl"
(v1.0) pkg> add "https://github.com/janattig/LatPhysReciprocal.jl"
(v1.0) pkg> add "https://github.com/janattig/LatPhysBandstructures.jl"
(v1.0) pkg> add "https://github.com/janattig/LatPhysLuttingerTisza.jl"

to finally install the main package with

(v1.0) pkg> add "https://github.com/janattig/LatticePhysics.jl"

Sub-modules

The main code is divided into various sub-modules, which can be found here:

  1. LatPhysBase
  2. LatPhysUnitcellLibrary
  3. LatPhysLatticeConstruction
  4. LatPhysLatticeModification
  5. LatPhysReciprocal
  6. LatPhysBandstructures
  7. LatPhysLuttingerTisza

Additionally, there are modules to provide plotting functions, which can be found here:

  1. LatPhysPlottingPyPlot
  2. LatPhysPlottingSVG
  3. LatPhysReciprocalPlottingPyPlot
  4. LatPhysBandstructuresPlottingPyPlot
  5. LatPhysLuttingerTiszaPlottingPyPlot

The plotting modules have to be used explicitly inside user code as they are not a direct part of LatticePhysics.jl.

About

Lattice Construction for Applications in Physics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published