From 55ccce26e1dad9075086158ac88c0e61d9551787 Mon Sep 17 00:00:00 2001 From: Thomas Christensen Date: Wed, 13 Oct 2021 19:49:43 -0400 Subject: [PATCH] add a readme to Bravais.jl --- Bravais/README.md | 24 ++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 Bravais/README.md diff --git a/Bravais/README.md b/Bravais/README.md new file mode 100644 index 00000000..b64901f2 --- /dev/null +++ b/Bravais/README.md @@ -0,0 +1,24 @@ +# Bravais.jl + +[![Documentation (stable)][docs-stable-img]][docs-stable-url] [![Documentation (dev)][docs-dev-img]][docs-dev-url] [![Build status][ci-status-img]][ci-status-url] + +Tools for treating lattice bases, crystal systems, and Bravais types. + +--- + +Bravais.jl is developed as a light-weight shared utility package for [Crystalline.jl](https://github.com/thchr/Crystalline.jl) and [Brillouin.jl](https://github.com/thchr/Brillouin.jl), intended to give access to a set of systematic conventions and tools related to point lattices as they arise in crystallography and space group theory. + +See the associated [documentation][docs-dev-url] for a specification of available methods and public API. + +## Citation + +If you find this package useful in your reseach, consider citing our arXiv paper: + +- T. Christensen, H.C. Po, J.D. Joannopoulos, & M. Soljačić, *Location and topology of the fundamental gap in photonic crystals*, [arXiv:2106.10267 (2021)](https://arxiv.org/abs/2106.10267) + +[ci-status-img]: https://github.com/thchr/Crystalline.jl/workflows/CI/badge.svg +[ci-status-url]: https://github.com/thchr/Crystalline.jl/actions +[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg +[docs-dev-url]: https://thchr.github.io/Crystalline.jl/dev/bravais/ +[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg +[docs-stable-url]: https://thchr.github.io/Crystalline.jl/stable/bravais/ \ No newline at end of file diff --git a/README.md b/README.md index c9c0a7c7..5a883f23 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ Crystalline.jl is a research package in active development: breaking changes are If you find this package useful in your reseach, please cite our arXiv paper: -- T. Christensen, H.C. Po, J.D. Joannopoulos, M. Soljačić, *Location and topology of the fundamental gap in photonic crystals*, [arXiv:2106.10267 (2021)](https://arxiv.org/abs/2106.10267) +- T. Christensen, H.C. Po, J.D. Joannopoulos, & M. Soljačić, *Location and topology of the fundamental gap in photonic crystals*, [arXiv:2106.10267 (2021)](https://arxiv.org/abs/2106.10267) In addition, please cite any works explicitly referenced in documentation for individual methods that you use.