Skip to content

Commit 2adbe7f

Browse files
author
CosmoMatt
committed
Test pip deployment (success). Final formatting of .rst's
1 parent 807b7b8 commit 2adbe7f

File tree

2 files changed

+68
-19
lines changed

2 files changed

+68
-19
lines changed

‎src/main/pyflag/.FLAG_Python_Documentation.rst‎

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,37 +8,59 @@ FLAG: Fourier-LAGuerre transform
88
.. image:: https://github.com/astro-informatics/src_flag/actions/workflows/cpp.yml/badge.svg
99
:target: https://github.com/astro-informatics/src_flag/actions/workflows/cpp.yml
1010

11+
.. image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest
12+
:target: https://astro-informatics.github.io/src_flag/
13+
1114
.. image:: https://img.shields.io/badge/License-GPL-blue.svg
1215
:target: http://perso.crans.org/besson/LICENSE.html
1316

1417
.. image:: http://img.shields.io/badge/arXiv-1205.0792-orange.svg?style=flat
1518
:target: https://arxiv.org/abs/1205.0792
1619

20+
.. image:: http://img.shields.io/badge/arXiv-1110.6298-orange.svg?style=flat
21+
:target: https://arxiv.org/abs/1110.6298
22+
23+
.. image:: http://img.shields.io/badge/arXiv-2105.05518-orange.svg?style=flat
24+
:target: https://arxiv.org/abs/2105.05518
25+
1726
DESCRIPTION
1827
================================
19-
The FLAG code provides functionality to perform fast and exact
20-
Fourier-Laguerre and Fourier-Bessel transforms on the ball.
28+
The FLAG code provides functionality to perform fast and exact Fourier-Laguerre and Fourier-Bessel transforms on the ball. More details may be found in the extensive `documentation <https://astro-informatics.github.io/flag/>`_.
2129

22-
DOCUMENTATION
30+
BASIC USAGE
2331
================================
32+
First install flag for python by running
2433

25-
See doc/index.html
34+
.. code-block:: bash
2635
27-
INSTALLATION
28-
================================
36+
pip install pyflag
2937
38+
Then you can call it from python to perform forward and inverse flag transforms and their adjoints by
3039

31-
.. code-block:: bash
40+
.. code-block:: python
41+
42+
import pyflag as flag
43+
import numpy as np
44+
45+
L = 10 # Angular bandlimit
46+
P = 5 # Radial bandlimit
47+
tau = 1 # Laguerre scaling factor
48+
spin = 0 # Spin of signal
49+
reality = 0 # Real or complex signals
50+
51+
# Create a random complex signal (c indexing)
52+
f = np.random.rand(P, L, 2*L-1) + 1j*np.random.rand(P, L, 2*L-1)
53+
f = f.flatten('C')
3254
33-
pip install flag
34-
pip list
55+
# Compute e.g. the Forward transform
56+
flmp = flag.flag_analysis(f, L, tau, P, spin, reality)
3557
36-
AUTHORS
58+
Contributors
3759
================================
3860

39-
`B. Leistedt <www.ixkael.com/blog>`_
40-
`J. D. McEwen <www.jasonmcewen.org>`_
41-
`M. A. Price <https://scholar.google.com/citations?user=w7_VDLQAAAAJ&hl=en&authuser=1>`_
61+
`B. Leistedt <www.ixkael.com/blog>`_,
62+
`J. D. McEwen <www.jasonmcewen.org>`_, and
63+
`M. A. Price <https://scholar.google.com/citations?user=w7_VDLQAAAAJ&hl=en&authuser=1>`_
4264

4365
REFERENCES
4466
================================

‎src/main/pyflag/README.rst‎

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,32 @@ FLAG: Fourier-LAGuerre transform
88
.. image:: https://github.com/astro-informatics/src_flag/actions/workflows/cpp.yml/badge.svg
99
:target: https://github.com/astro-informatics/src_flag/actions/workflows/cpp.yml
1010

11+
.. image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest
12+
:target: https://astro-informatics.github.io/src_flag/
13+
1114
.. image:: https://img.shields.io/badge/License-GPL-blue.svg
1215
:target: http://perso.crans.org/besson/LICENSE.html
1316

1417
.. image:: http://img.shields.io/badge/arXiv-1205.0792-orange.svg?style=flat
1518
:target: https://arxiv.org/abs/1205.0792
1619

17-
DESCRIPTION
18-
================================
19-
The FLAG code provides functionality to perform fast and exact Fourier-Laguerre and Fourier-Bessel transforms on the ball.
20+
.. image:: http://img.shields.io/badge/arXiv-1110.6298-orange.svg?style=flat
21+
:target: https://arxiv.org/abs/1110.6298
2022

21-
DOCUMENTATION
23+
.. image:: http://img.shields.io/badge/arXiv-2105.05518-orange.svg?style=flat
24+
:target: https://arxiv.org/abs/2105.05518
25+
26+
DESCRIPTION
2227
================================
23-
See the `code webiste <https://astro-informatics.github.io/flag/>`_ for full documentation and installation procedures.
28+
The FLAG code provides functionality to perform fast and exact Fourier-Laguerre and Fourier-Bessel transforms on the ball. More details may be found in the extensive `documentation <https://astro-informatics.github.io/flag/>`_.
2429

2530
INSTALLATION
2631
================================
2732
This package can easily be installed from PyPi by running
2833

2934
.. code-block:: bash
3035
31-
pip install flag
36+
pip install pyflag
3237
pip list
3338
3439
or alternatively from source by first compiling the C++ code and running
@@ -39,6 +44,28 @@ or alternatively from source by first compiling the C++ code and running
3944
4045
from the root directory.
4146

47+
BASIC USAGE
48+
================================
49+
First install flag for python, then you can call it from any python script to perform forward and inverse flag transforms and their adjoints by
50+
51+
.. code-block:: python
52+
53+
import pyflag as flag
54+
import numpy as np
55+
56+
L = 10 # Angular bandlimit
57+
P = 5 # Radial bandlimit
58+
tau = 1 # Laguerre scaling factor
59+
spin = 0 # Spin of signal
60+
reality = 0 # Real or complex signals
61+
62+
# Create a random complex signal (c indexing)
63+
f = np.random.rand(P, L, 2*L-1) + 1j*np.random.rand(P, L, 2*L-1)
64+
f = f.flatten('C')
65+
66+
# Compute e.g. the Forward transform
67+
flmp = flag.flag_analysis(f, L, tau, P, spin, reality)
68+
4269
AUTHORS
4370
================================
4471

0 commit comments

Comments
 (0)