Skip to content

Commit fc13678

Browse files
committed
add a quick docstring to mspacegroup
1 parent 890d1d8 commit fc13678

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/assembly/groups/mspacegroup.jl

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
"""
2+
mspacegroup(BNS₁, BNS₂)
3+
mspacegroup(OG₃) --> MSpaceGroup{3}
4+
5+
Return the magnetic space group with BNS numbers `(BNS₁, BNS₂)` or the sequential OG number
6+
`OG₃` (from 1 to 1651).
7+
8+
## Data sources
9+
The data underlying this function was retrieved from ISOTROPY's compilation of Daniel
10+
Litvin's magnetic space group tables (http://www.bk.psu.edu/faculty/litvin/Download.html).
11+
"""
112
function mspacegroup(BNS₁::Integer, BNS₂::Integer, Dᵛ::Val{D}=Val(3)) where D
213
D == 3 || throw(DomainError("only 3D magnetic space groups are supported"))
314
msgnum = (BNS₁, BNS₂)

0 commit comments

Comments
 (0)