https://github.com/JuliaPhysics/Lattices.jl

A Lattice Library for Julia
https://github.com/JuliaPhysics/Lattices.jl

geometry hacktoberfest julia lattices tiling

Last synced: 14 days ago
JSON representation

A Lattice Library for Julia

• Host: GitHub
• URL: https://github.com/JuliaPhysics/Lattices.jl
• Owner: JuliaPhysics
• License: apache-2.0
• Created: 2018-09-10T19:11:57.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-01-05T17:48:48.000Z (almost 4 years ago)
• Last Synced: 2024-05-01T15:39:56.019Z (7 months ago)
• Topics: geometry, hacktoberfest, julia, lattices, tiling
• Language: Julia
• Homepage: https://juliaphysics.github.io/Lattices.jl
• Size: 123 KB
• Stars: 35
• Watchers: 7
• Forks: 6
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lattices.jl

[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliaphysics.github.io/Lattices.jl)

[![travis][travis-img]](https://travis-ci.org/JuliaPhysics/Lattices.jl)

[![license: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT)

![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)

[travis-img]: https://img.shields.io/travis/JuliaPhysics/Lattices.jl/master.svg?label=Linux%20/%20MacOS

A library for defining lattices in Julia.

**Warning**: This package is still at very early stage for exploring a potential Julian interface for lattices. Take your own risk of using the package, and please feel free to join the discussions in the issues and PRs.

## Install

```

pkg> add Lattices

```

## A glance of the interface

```julia-repl

julia> using Lattices               

                                    

julia> l = Chain(4)                 

Chain Lattice                       

boundary: Periodic                  

size:     (4,)                      

                                    

julia> for each in sites(l)         

           @show each               

       end                          

each = 1                            

each = 2                            

each = 3                            

each = 4                            

                                    

julia> for (a, b) in edges(l)   

           println(a, " <-> ", b)

       end                          

1 <-> 2                              

2 <-> 3                              

3 <-> 4                              

4 <-> 1                              

```

## TODO

- [ ] Site Type

- [ ] Hexagonel Lattice

- [ ] Triangular Lattice

## License

Apache License Version 2.0