Skip to content

Commit 1e7cc81

Browse files
authored
Update README.md
1 parent 945e71d commit 1e7cc81

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,50 @@
22
transformcl
33
===========
44

5-
**transform angular power spectra and correlation functions**
5+
**Transform angular power spectra and correlation functions.**
66

77
This is a minimal Python package for transformations between angular power
8-
spectra and correlation functions. It is currently limited to the zero spin
8+
spectra and correlation functions. It is currently limited to the spin zero
99
case.
1010

1111
The package can be installed using pip:
1212

1313
pip install transformcl
1414

15-
Then import the `cltocorr` and `corrtocl` functions from the package:
15+
Then import the package to use the functions:
1616

17-
from transformcl import cltocorr, corrtocl
17+
```py
18+
import transformcl
19+
t = transformcl.theta(cl.size)
20+
ct = transformcl.corr(cl)
21+
```
1822

1923
For more information, please see the [documentation].
2024

2125
Current functionality covers the absolutely minimal use case. Please open an
2226
issue on GitHub if you would like to see anything added.
2327

24-
[documentation]: https://cltools.readthedocs.io/transformcl/
28+
[documentation]: https://glass.readthedocs.io/projects/transformcl/latest
29+
30+
31+
Backends
32+
--------
33+
The `transformcl` package supports multiple transform backends. The
34+
current backend can be changed globally by assigning to
35+
`transformcl.backend`:
36+
37+
```py
38+
transformcl.backend = "<choice>"
39+
...
40+
```
41+
42+
or using the `transformcl.use()` context manager:
43+
44+
```py
45+
with transformcl.use("<choice>"):
46+
...
47+
```
48+
49+
The list of available backends can be found in the [documentation][backends].
50+
51+
[backends]: https://glass.readthedocs.io/projects/transformcl/latest#backends

0 commit comments

Comments
 (0)