sphrs 0.2.2

Spherical harmonics and solid harmonics
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

<p align="center">
  <a href="https://crates.io/crates/sphrs"
    ><img
      src="https://img.shields.io/crates/v/sphrs?style=flat-square"
      alt="Crates.io version"
  /></a>
  <a href="https://crates.io/crates/sphrs"
    ><img
      src="https://img.shields.io/crates/d/sphrs?style=flat-square"
      alt="Crates.io downloads"
  /></a>
  <a href="https://github.com/argmin-rs/sphrs/actions"
    ><img
      src="https://img.shields.io/github/actions/workflow/status/argmin-rs/sphrs/ci.yml?branch=main&label=sphrs CI&style=flat-square"
      alt="GitHub Actions workflow status"
  /></a>
  <a href="https://app.codecov.io/gh/argmin-rs/sphrs/"
    ><img
      src="https://img.shields.io/codecov/c/github/argmin-rs/sphrs/main?style=flat-square"
      alt="Code coverage"
  /></a>
  <img
    src="https://img.shields.io/crates/l/sphrs?style=flat-square"
    alt="License"
  />
  <a href="https://gitter.im/argmin-rs/community"
    ><img
      src="https://img.shields.io/gitter/room/argmin-rs/argmin?style=flat-square"
      alt="Gitter chat"
  /></a>
</p>


# sphrs

sphrs is a general purpose spherical harmonics and (regular and irregular) solid harmonics library in Rust.

For details on how to use sphrs, please consult the documentation, either for the
[latest stable release](https://docs.rs/sphrs/latest/sphrs),
or for the current 
[main branch](https://argmin-rs.github.io/sphrs/sphrs/).

## Acknowledgements

This crate is heavily inspired by Google's
[spherical-harmonics](https://github.com/google/spherical-harmonics) library and follows the
mathematics documented [here](https://basesandframes.files.wordpress.com/2016/05/spherical_harmonic_lighting_gritty_details_green_2003.pdf).

## References

* Robin Green, ["Spherical Harmonic Lighting: The Gritty Details"](https://basesandframes.files.wordpress.com/2016/05/spherical_harmonic_lighting_gritty_details_green_2003.pdf)
* [Spherical harmonics (Wikipedia)](https://en.wikipedia.org/wiki/Spherical_harmonics)
* [Solid harmonics (Wikipedia)](https://en.wikipedia.org/wiki/Spherical_harmonics)

## License

Licensed under either of

  * Apache License, Version 2.0,
    ([LICENSE-APACHE](https://github.com/argmin-rs/argmin/blob/main/LICENSE-APACHE) or
    http://www.apache.org/licenses/LICENSE-2.0)
  * MIT License ([LICENSE-MIT](https://github.com/argmin-rs/argmin/blob/main/LICENSE-MIT) or
    http://opensource.org/licenses/MIT)

at your option.


### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion
in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above,
without any additional terms or conditions.

License: MIT OR Apache-2.0