Skip to content

Commit 6d2221e

Browse files
author
CosmoMatt
committed
tidy docs and test pypi deployment (success)
1 parent 88cafbd commit 6d2221e

File tree

6 files changed

+101
-110
lines changed

6 files changed

+101
-110
lines changed

‎conanfile.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class FlagletConan(ConanFile):
1515
generators = "cmake"
1616
exports_sources = [
1717
"src/main/c/*",
18-
"include/flaglet*",
18+
"include/*.h",
1919
"CMakeLists.txt",
2020
"cmake/*.cmake",
2121
"src/test/c/*.c",

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
setup(
1111
name="pyflaglet",
1212
version="0.0.1",
13-
author="Boris Leistedt & Jason McEwen",
13+
author="Boris Leistedt & Jason McEwen & Matthew Price",
1414
install_requires=["numpy", "cython", "scipy"],
1515
extras_require={
1616
"dev": [

‎src/main/pyflaglet/.FLAGLET_Python_Documentation.rst‎

Lines changed: 50 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ Then you can call it from any python script to perform forward and inverse flag
4646
4747
# Create a random complex signal (c indexing)
4848
f_size = flaglet.flaglet_f_dim(parameters)
49-
rng = np.random.default_rng()
50-
f = rng.normal(size=(f_size)) + 1j*rng.normal(size=(f_size))
49+
rng = np.random.default_rng()
50+
f = rng.normal(size=(f_size)) + 1j*rng.normal(size=(f_size))
5151
5252
# Compute e.g. the Forward transform
5353
f_wav_input, f_scal_input = flaglet.flaglet_ana(f, parameters)
@@ -65,85 +65,84 @@ REFERENCES
6565
.. code-block::
6666
6767
@article{price:2021:bayesian,
68-
author = {Matthew~A.~Price and Jason~D.~McEwen},
69-
title = {Bayesian variational regularization on the ball},
70-
journal = {ArXiv},
71-
eprint = {arXiv:2105.05518},
72-
year = 2021
68+
author = {Matthew~A.~Price and Jason~D.~McEwen},
69+
title = {Bayesian variational regularization on the ball},
70+
journal = {ArXiv},
71+
eprint = {arXiv:2105.05518},
72+
year = 2021
7373
}
7474
7575
.. code-block::
7676
7777
@article{leistedt:2012:exact,
78-
author = {Boris~Leistedt and Jason~D.~McEwen},
79-
title = {Exact Wavelets on the Ball},
80-
journal = {IEEE Trans. Sig. Proc.},
81-
year = 2012,
82-
volume = {60},
83-
number = {12},
84-
pages = {6257-6269},
85-
doi = {10.1109/TSP.2012.2215030},
78+
author = {Boris~Leistedt and Jason~D.~McEwen},
79+
title = {Exact Wavelets on the Ball},
80+
journal = {IEEE Trans. Sig. Proc.},
81+
year = 2012,
82+
volume = {60},
83+
number = {12},
84+
pages = {6257-6269},
85+
doi = {10.1109/TSP.2012.2215030},
8686
}
8787
8888
.. code-block::
8989
9090
@article{McEwen:2011:novel,
91-
author = {Jason~D.~McEwen and Yves~Wiaux},
92-
title = {A novel sampling theorem on the
93-
sphere},
94-
journal = {IEEE Trans. Sig. Proc.},
95-
year = 2011,
96-
volume = {59},
97-
number = {12},
98-
pages = {5876-5887},
99-
doi = {10.1109/TSP.2011.2166394},
91+
author = {Jason~D.~McEwen and Yves~Wiaux},
92+
title = {A novel sampling theorem on the sphere},
93+
journal = {IEEE Trans. Sig. Proc.},
94+
year = 2011,
95+
volume = {59},
96+
number = {12},
97+
pages = {5876-5887},
98+
doi = {10.1109/TSP.2011.2166394},
10099
}
101100
102101
.. code-block::
103102
104103
@article{Leistedt:2015:3dlensing,
105-
author = {Boris~Leistedt and Jason~D.~McEwen and Thomas~D.~Kitching and Hiranya~V.Peiris},
106-
title = {3D weak lensing with spin wavelets on the ball},
107-
journal = {Physical Review D.},
108-
year = 2015,
109-
volume = {92},
110-
number = {12},
111-
pages = {123010},
112-
doi = {10.1103/PhysRevD.92.123010},
104+
author = {Boris~Leistedt and Jason~D.~McEwen and Thomas~D.~Kitching and Hiranya~V.Peiris},
105+
title = {3D weak lensing with spin wavelets on the ball},
106+
journal = {Physical Review D.},
107+
year = 2015,
108+
volume = {92},
109+
number = {12},
110+
pages = {123010},
111+
doi = {10.1103/PhysRevD.92.123010},
113112
}
114113
115114
.. code-block::
116115
117116
@article{McEwen:2015:3dlensing,
118-
author = {Jason~D.~McEwen and Martin~Büttner and Boris~Leistedt and Hiranya~V.Peiris and Yves~Wiaux},
119-
title = {A Novel Sampling Theorem on the Rotation Group},
120-
journal = {IEEE Sig. Proc. Letters},
121-
year = 2015,
122-
volume = {22},
123-
number = {12},
124-
pages = {2425-2429},
125-
doi = {10.1109/LSP.2015.2490676},
117+
author = {Jason~D.~McEwen and Martin~Büttner and Boris~Leistedt and Hiranya~V.Peiris and Yves~Wiaux},
118+
title = {A Novel Sampling Theorem on the Rotation Group},
119+
journal = {IEEE Sig. Proc. Letters},
120+
year = 2015,
121+
volume = {22},
122+
number = {12},
123+
pages = {2425-2429},
124+
doi = {10.1109/LSP.2015.2490676},
126125
}
127126
128127
.. code-block::
129128
130129
@article{McEwen:2015:s2spinwavelets,
131-
author = {Jason~D.~McEwen and Boris~Leistedt and Martin~Büttner and Hiranya~V.Peiris and Yves~Wiaux },
132-
title = {Directional spin wavelets on the sphere},
133-
journal = {arXiv e-prints},
134-
eprint = {1509.06749},
135-
year = 2015,
130+
author = {Jason~D.~McEwen and Boris~Leistedt and Martin~Büttner and Hiranya~V.Peiris and Yves~Wiaux },
131+
title = {Directional spin wavelets on the sphere},
132+
journal = {arXiv e-prints},
133+
eprint = {1509.06749},
134+
year = 2015,
136135
}
137136
138137
.. code-block::
139138
140139
@article{leistedt:2013:s2let,
141-
title={S2LET: A code to perform fast wavelet analysis on the sphere},
142-
author={Boris~Leistedt and Jason~D.~McEwen and Pierre~Vandergheynst and Yves~Wiaux},
143-
journal={Astronomy & Astrophysics},
144-
volume={558},
145-
pages={A128},
146-
year=2013,
140+
title = {S2LET: A code to perform fast wavelet analysis on the sphere},
141+
author = {Boris~Leistedt and Jason~D.~McEwen and Pierre~Vandergheynst and Yves~Wiaux},
142+
journal = {Astronomy & Astrophysics},
143+
volume = {558},
144+
pages = {A128},
145+
year = 2013,
147146
}
148147
149148
LICENSE

‎src/main/pyflaglet/README.rst‎

Lines changed: 48 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -76,85 +76,84 @@ REFERENCES
7676
.. code-block::
7777
7878
@article{price:2021:bayesian,
79-
author = {Matthew~A.~Price and Jason~D.~McEwen},
80-
title = {Bayesian variational regularization on the ball},
81-
journal = {ArXiv},
82-
eprint = {arXiv:2105.05518},
83-
year = 2021
79+
author = {Matthew~A.~Price and Jason~D.~McEwen},
80+
title = {Bayesian variational regularization on the ball},
81+
journal = {ArXiv},
82+
eprint = {arXiv:2105.05518},
83+
year = 2021
8484
}
8585
8686
.. code-block::
8787
8888
@article{leistedt:2012:exact,
89-
author = {Boris~Leistedt and Jason~D.~McEwen},
90-
title = {Exact Wavelets on the Ball},
91-
journal = {IEEE Trans. Sig. Proc.},
92-
year = 2012,
93-
volume = {60},
94-
number = {12},
95-
pages = {6257-6269},
96-
doi = {10.1109/TSP.2012.2215030},
89+
author = {Boris~Leistedt and Jason~D.~McEwen},
90+
title = {Exact Wavelets on the Ball},
91+
journal = {IEEE Trans. Sig. Proc.},
92+
year = 2012,
93+
volume = {60},
94+
number = {12},
95+
pages = {6257-6269},
96+
doi = {10.1109/TSP.2012.2215030},
9797
}
9898
9999
.. code-block::
100100
101101
@article{McEwen:2011:novel,
102-
author = {Jason~D.~McEwen and Yves~Wiaux},
103-
title = {A novel sampling theorem on the
104-
sphere},
105-
journal = {IEEE Trans. Sig. Proc.},
106-
year = 2011,
107-
volume = {59},
108-
number = {12},
109-
pages = {5876-5887},
110-
doi = {10.1109/TSP.2011.2166394},
102+
author = {Jason~D.~McEwen and Yves~Wiaux},
103+
title = {A novel sampling theorem on the sphere},
104+
journal = {IEEE Trans. Sig. Proc.},
105+
year = 2011,
106+
volume = {59},
107+
number = {12},
108+
pages = {5876-5887},
109+
doi = {10.1109/TSP.2011.2166394},
111110
}
112111
113112
.. code-block::
114113
115114
@article{Leistedt:2015:3dlensing,
116-
author = {Boris~Leistedt and Jason~D.~McEwen and Thomas~D.~Kitching and Hiranya~V.Peiris},
117-
title = {3D weak lensing with spin wavelets on the ball},
118-
journal = {Physical Review D.},
119-
year = 2015,
120-
volume = {92},
121-
number = {12},
122-
pages = {123010},
123-
doi = {10.1103/PhysRevD.92.123010},
115+
author = {Boris~Leistedt and Jason~D.~McEwen and Thomas~D.~Kitching and Hiranya~V.Peiris},
116+
title = {3D weak lensing with spin wavelets on the ball},
117+
journal = {Physical Review D.},
118+
year = 2015,
119+
volume = {92},
120+
number = {12},
121+
pages = {123010},
122+
doi = {10.1103/PhysRevD.92.123010},
124123
}
125124
126125
.. code-block::
127126
128127
@article{McEwen:2015:3dlensing,
129-
author = {Jason~D.~McEwen and Martin~Büttner and Boris~Leistedt and Hiranya~V.Peiris and Yves~Wiaux},
130-
title = {A Novel Sampling Theorem on the Rotation Group},
131-
journal = {IEEE Sig. Proc. Letters},
132-
year = 2015,
133-
volume = {22},
134-
number = {12},
135-
pages = {2425-2429},
136-
doi = {10.1109/LSP.2015.2490676},
128+
author = {Jason~D.~McEwen and Martin~Büttner and Boris~Leistedt and Hiranya~V.Peiris and Yves~Wiaux},
129+
title = {A Novel Sampling Theorem on the Rotation Group},
130+
journal = {IEEE Sig. Proc. Letters},
131+
year = 2015,
132+
volume = {22},
133+
number = {12},
134+
pages = {2425-2429},
135+
doi = {10.1109/LSP.2015.2490676},
137136
}
138137
139138
.. code-block::
140139
141140
@article{McEwen:2015:s2spinwavelets,
142-
author = {Jason~D.~McEwen and Boris~Leistedt and Martin~Büttner and Hiranya~V.Peiris and Yves~Wiaux },
143-
title = {Directional spin wavelets on the sphere},
144-
journal = {arXiv e-prints},
145-
eprint = {1509.06749},
146-
year = 2015,
141+
author = {Jason~D.~McEwen and Boris~Leistedt and Martin~Büttner and Hiranya~V.Peiris and Yves~Wiaux },
142+
title = {Directional spin wavelets on the sphere},
143+
journal = {arXiv e-prints},
144+
eprint = {1509.06749},
145+
year = 2015,
147146
}
148147
149148
.. code-block::
150149
151150
@article{leistedt:2013:s2let,
152-
title={S2LET: A code to perform fast wavelet analysis on the sphere},
153-
author={Boris~Leistedt and Jason~D.~McEwen and Pierre~Vandergheynst and Yves~Wiaux},
154-
journal={Astronomy & Astrophysics},
155-
volume={558},
156-
pages={A128},
157-
year=2013,
151+
title = {S2LET: A code to perform fast wavelet analysis on the sphere},
152+
author = {Boris~Leistedt and Jason~D.~McEwen and Pierre~Vandergheynst and Yves~Wiaux},
153+
journal = {Astronomy & Astrophysics},
154+
volume = {558},
155+
pages = {A128},
156+
year = 2013,
158157
}
159158
160159
LICENSE

‎src/main/pyflaglet/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
"""FLAG module."""
1+
"""FLAGLET module."""
22

33
from .bindings import *

‎src/test/pyflaglet/test_pyflaglet.py‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import numpy as np
22
from pytest import approx
3-
43
import pyflaglet as flaglet
54

65
def test_directional_transform():
@@ -18,8 +17,6 @@ def test_directional_transform():
1817
reality = 0,
1918
tau = 1.0)
2019

21-
f_wav_size = flaglet.flaglet_wav_dim(parameters)
22-
f_scal_size = flaglet.flaglet_scal_dim(parameters)
2320
f_size = flaglet.flaglet_f_dim(parameters)
2421

2522
rng = np.random.default_rng()
@@ -49,8 +46,6 @@ def test_directional_analysis_adjoint_transform():
4946
reality = 0,
5047
tau = 1.0)
5148

52-
f_wav_size = flaglet.flaglet_wav_dim(parameters)
53-
f_scal_size = flaglet.flaglet_scal_dim(parameters)
5449
f_size = flaglet.flaglet_f_dim(parameters)
5550

5651
rng = np.random.default_rng()
@@ -81,8 +76,6 @@ def test_directional_synthesis_adjoint_transform():
8176
reality = 0,
8277
tau = 1.0)
8378

84-
f_wav_size = flaglet.flaglet_wav_dim(parameters)
85-
f_scal_size = flaglet.flaglet_scal_dim(parameters)
8679
f_size = flaglet.flaglet_f_dim(parameters)
8780

8881
rng = np.random.default_rng()

0 commit comments

Comments
 (0)