summaryrefslogtreecommitdiff
path: root/python-tkmatrix.spec
blob: c3b5f11a1daddaffb0ea3fe6a3e80c1a9dab580e (plain)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
%global _empty_manifest_terminate_build 0
Name:		python-tkmatrix
Version:	0.6.2
Release:	1
Summary:	ToolKit for Multi-phAse Transits Recovery from Injected eXoplanets
License:	MIT License
URL:		https://github.com/PlanetHunters/tkmatrix
Source0:	https://mirrors.aliyun.com/pypi/web/packages/9c/20/41695d7f4f6be705dad869e88a2277e1d09be5b30183151a77570096db35/tkmatrix-0.6.2.tar.gz
BuildArch:	noarch

Requires:	python3-argparse
Requires:	python3-beautifulsoup4
Requires:	python3-configparser
Requires:	python3-corner
Requires:	python3-cython
Requires:	python3-ellc
Requires:	python3-lcbuilder
Requires:	python3-matplotlib
Requires:	python3-mock
Requires:	python3-numba
Requires:	python3-pyparsing
Requires:	python3-seaborn
Requires:	python3-setuptools
Requires:	python3-scipy
Requires:	python3-sklearn
Requires:	python3-tqdm
Requires:	python3-wotan

%description
<p align="center">
  <img width="400px" src="https://github.com/martindevora/tkmatrix/blob/master/images/matrix.jpg?raw=true">
</p>

# MATRIX ToolKit
ToolKit for Multi-phAse Transits Recovery from Injected eXoplanets

## Citation
We are planning to write a scientific paper based on the usage of MATRIX. In the meantime, we encourage the users to cite the Software DOI in their research:
```
@MISC{2022zndo...6570831D,
       author = {{D{\'e}vora-Pajares}, Mart{\'\i}n and {Pozuelos}, Francisco J.},
        title = "{MATRIX: Multi-phAse Transits Recovery from Injected eXoplanets}",
     keywords = {exoplanets, transits, injection \& recovery, python},
 howpublished = {Zenodo},
         year = 2022,
        month = may,
          eid = {10.5281/zenodo.6570831},
          doi = {10.5281/zenodo.6570831},
      version = {0.3.17},
    publisher = {Zenodo},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2022zndo...6570831D},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```

## Main Developers
[M. Dévora Pajares](https://github.com/martindevora)

[F.J. Pozuelos](https://github.com/franpoz)


## Additional contributors
[L. Cerdeño Mota](https://github.com/LuisCerdenoMota) 

## Installation
Supported Python versions: 3.8, 3.9. Install with:

```
python3.8 -m pip install numpy==1.22.4
python3.8 -m pip install -r requirements.txt
```

You can find the requirements.txt file [here](https://github.com/PlanetHunters/tkmatrix/blob/master/requirements.txt). 

## Tests
We use [tox](https://tox.readthedocs.io) to test MATRIX under all the supported Python versions. Usage:

`tox`

## Examples
Under the [examples](https://github.com/PlanetHunters/tkmatrix/tree/master/examples) directory.

## Execution
Just execute the command below this text. Take into accont that the `user-properties.yaml` file needs to include several mandatory options. Please refer to the example file under the examples directory.

`python3.8 -m tkmatrix --properties user-properties.yaml`

## By-products
* a_tls_report.csv: A file containing a csv formatted output given the orbital period, the radius and the epoch besides the outputs with found status, SNR and SDE of the results.
* a_tls_report.png: A file with an automatically generated plot from the csv report. You are free to build your own plot from the report if you feel like the one provided by MATRIX is not good enough for your purposes.
* Injected curves (csv files): In case you want to study the injected curves generated for the recovery, you can set a flag to the tool so that it keeps the files after it finishes. If you don't provide that flag, the files will be removed at the end of the execution.




%package -n python3-tkmatrix
Summary:	ToolKit for Multi-phAse Transits Recovery from Injected eXoplanets
Provides:	python-tkmatrix
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-tkmatrix
<p align="center">
  <img width="400px" src="https://github.com/martindevora/tkmatrix/blob/master/images/matrix.jpg?raw=true">
</p>

# MATRIX ToolKit
ToolKit for Multi-phAse Transits Recovery from Injected eXoplanets

## Citation
We are planning to write a scientific paper based on the usage of MATRIX. In the meantime, we encourage the users to cite the Software DOI in their research:
```
@MISC{2022zndo...6570831D,
       author = {{D{\'e}vora-Pajares}, Mart{\'\i}n and {Pozuelos}, Francisco J.},
        title = "{MATRIX: Multi-phAse Transits Recovery from Injected eXoplanets}",
     keywords = {exoplanets, transits, injection \& recovery, python},
 howpublished = {Zenodo},
         year = 2022,
        month = may,
          eid = {10.5281/zenodo.6570831},
          doi = {10.5281/zenodo.6570831},
      version = {0.3.17},
    publisher = {Zenodo},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2022zndo...6570831D},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```

## Main Developers
[M. Dévora Pajares](https://github.com/martindevora)

[F.J. Pozuelos](https://github.com/franpoz)


## Additional contributors
[L. Cerdeño Mota](https://github.com/LuisCerdenoMota) 

## Installation
Supported Python versions: 3.8, 3.9. Install with:

```
python3.8 -m pip install numpy==1.22.4
python3.8 -m pip install -r requirements.txt
```

You can find the requirements.txt file [here](https://github.com/PlanetHunters/tkmatrix/blob/master/requirements.txt). 

## Tests
We use [tox](https://tox.readthedocs.io) to test MATRIX under all the supported Python versions. Usage:

`tox`

## Examples
Under the [examples](https://github.com/PlanetHunters/tkmatrix/tree/master/examples) directory.

## Execution
Just execute the command below this text. Take into accont that the `user-properties.yaml` file needs to include several mandatory options. Please refer to the example file under the examples directory.

`python3.8 -m tkmatrix --properties user-properties.yaml`

## By-products
* a_tls_report.csv: A file containing a csv formatted output given the orbital period, the radius and the epoch besides the outputs with found status, SNR and SDE of the results.
* a_tls_report.png: A file with an automatically generated plot from the csv report. You are free to build your own plot from the report if you feel like the one provided by MATRIX is not good enough for your purposes.
* Injected curves (csv files): In case you want to study the injected curves generated for the recovery, you can set a flag to the tool so that it keeps the files after it finishes. If you don't provide that flag, the files will be removed at the end of the execution.




%package help
Summary:	Development documents and examples for tkmatrix
Provides:	python3-tkmatrix-doc
%description help
<p align="center">
  <img width="400px" src="https://github.com/martindevora/tkmatrix/blob/master/images/matrix.jpg?raw=true">
</p>

# MATRIX ToolKit
ToolKit for Multi-phAse Transits Recovery from Injected eXoplanets

## Citation
We are planning to write a scientific paper based on the usage of MATRIX. In the meantime, we encourage the users to cite the Software DOI in their research:
```
@MISC{2022zndo...6570831D,
       author = {{D{\'e}vora-Pajares}, Mart{\'\i}n and {Pozuelos}, Francisco J.},
        title = "{MATRIX: Multi-phAse Transits Recovery from Injected eXoplanets}",
     keywords = {exoplanets, transits, injection \& recovery, python},
 howpublished = {Zenodo},
         year = 2022,
        month = may,
          eid = {10.5281/zenodo.6570831},
          doi = {10.5281/zenodo.6570831},
      version = {0.3.17},
    publisher = {Zenodo},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2022zndo...6570831D},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```

## Main Developers
[M. Dévora Pajares](https://github.com/martindevora)

[F.J. Pozuelos](https://github.com/franpoz)


## Additional contributors
[L. Cerdeño Mota](https://github.com/LuisCerdenoMota) 

## Installation
Supported Python versions: 3.8, 3.9. Install with:

```
python3.8 -m pip install numpy==1.22.4
python3.8 -m pip install -r requirements.txt
```

You can find the requirements.txt file [here](https://github.com/PlanetHunters/tkmatrix/blob/master/requirements.txt). 

## Tests
We use [tox](https://tox.readthedocs.io) to test MATRIX under all the supported Python versions. Usage:

`tox`

## Examples
Under the [examples](https://github.com/PlanetHunters/tkmatrix/tree/master/examples) directory.

## Execution
Just execute the command below this text. Take into accont that the `user-properties.yaml` file needs to include several mandatory options. Please refer to the example file under the examples directory.

`python3.8 -m tkmatrix --properties user-properties.yaml`

## By-products
* a_tls_report.csv: A file containing a csv formatted output given the orbital period, the radius and the epoch besides the outputs with found status, SNR and SDE of the results.
* a_tls_report.png: A file with an automatically generated plot from the csv report. You are free to build your own plot from the report if you feel like the one provided by MATRIX is not good enough for your purposes.
* Injected curves (csv files): In case you want to study the injected curves generated for the recovery, you can set a flag to the tool so that it keeps the files after it finishes. If you don't provide that flag, the files will be removed at the end of the execution.




%prep
%autosetup -n tkmatrix-0.6.2

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-tkmatrix -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.6.2-1
- Package Spec generated