moyo 0.13.0

Library for Crystal Symmetry in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# moyo (Rust)

[![CI](https://github.com/spglib/moyo/actions/workflows/ci-rust.yaml/badge.svg)](https://github.com/spglib/moyo/actions/workflows/ci-rust.yaml)
[![moyo at crates.io](https://img.shields.io/crates/v/moyo.svg)](https://img.shields.io/crates/v/moyo)

The core implementation of moyo in Rust

- Crates.io: <https://crates.io/crates/moyo>
- Document: <https://docs.rs/moyo/latest/moyo/>

## Goals

- Find symmetry operations of a given crystal structure, identify its crystallographic group, and symmetrize the given crystal structure
- Well-defined tolerance for finding symmetry operations
- No dependency on existing symmetry-finder packages
- Simplify crystal symmetry algorithm by extensively exploiting the group structures of crystallographic groups

## Non-goals

- Crystallographic groups in other than three dimensions
- Matching two similar crystal structures

## Development

Run from the repo root with `just`:

```shell
just test   # cargo test
just doc    # cargo doc --open
```

### Module dependency

```text
math <- base <- data <- identify <- standardize <- lib
        ^---- search <--------------|
```

## How to cite moyo

See the citation information in [the root README](../README.md)