tessapps 0.3.0__tar.gz → 0.3.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: tessapps
3
- Version: 0.3.0
3
+ Version: 0.3.2
4
4
  Summary: TESS Aperture Photometry Pollution eStimator
5
5
  Author: Leonidas Liponis
6
6
  Requires-Python: >=3.10
@@ -29,7 +29,7 @@ A python module that calculates a contamination factor in the aperture region of
29
29
  <img src="https://codeberg.org/leolip128/tessapps/raw/branch/main/documentation/examples/images/HAT-P-1.png" alt="HAT-P-1 example" style="width:63.21%; height:auto;">
30
30
  </p>
31
31
 
32
- Full documentation is available [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/). Below is some useful information, taken from the documentation.
32
+ Full documentation is available [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/README.md). Below is some useful information, taken from the documentation.
33
33
 
34
34
  ## Installation
35
35
 
@@ -42,17 +42,15 @@ Full documentation is available [here](https://codeberg.org/leolip128/tessapps/s
42
42
  - ```matplotlib``` (>=3.5): to plot the result (shows aperture mask with a caption at the bottom)
43
43
  - ```lightkurve``` (>=2.0): to fetch and load tpf files
44
44
 
45
- Python >=3.10 is required. More information about dependencies can be found [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/installation).
45
+ Python >=3.10 is required. More information about dependencies can be found [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/installation/README.md).
46
46
 
47
- ### How to install
48
-
49
- Run ```pip install tessapps```.
47
+ Install with ```pip install tessapps```.
50
48
 
51
49
  ## Running the module
52
50
 
53
51
  ### Running from a notebook
54
52
 
55
- A tpf is needed to run this module. If no tpf is supplied, the default is a file with HAT-P-1 (the example picture above). So, here is the minimal example:
53
+ A tpf is needed to run this module. If no tpf is supplied, the default is a file with HAT-P-1 (the example picture above). Here is the minimal example:
56
54
  ```
57
55
  import tessapps
58
56
 
@@ -61,30 +59,28 @@ tessapps.run()
61
59
  >>> [0.57675, 0.00191]
62
60
  ```
63
61
 
64
- The first number is the contamination factor, and the second is its error. Here is a more realistic example with CoRoT-1 (also in the example images):
62
+ The first number is the contamination factor, and the second is its error. Here is a more realistic example:
65
63
 
66
64
  ```
67
- import lightkurve as lk
68
65
  import tessapps as tapps
66
+ from tessapps.search_parameters_to_tpf import find_tpf
69
67
 
70
- CoRoT_1_tpf = lk.search_targetpixelfile('CoRoT 1')[1].download()
71
- contamination, error = tapps.run(CoRoT_1_tpf, result=True)
68
+ tpf = find_tpf(TIC=346338552, mission="TESS", sector=84, exptime=120) # HAT-P-1
69
+ contamination, error = tapps.run(tpf, result=True)
72
70
 
73
- >>> The background contributes (2.249 ± 0.020)% of the total flux in the aperture region.
71
+ >>> The background contributes (57.675 ± 0.191)% of the total flux in the aperture region.
74
72
  ```
75
73
 
76
- This means that the contamination factor is 0.02249 ± 0.00020 (rounded).
74
+ More information about usage in [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/usage/README.md).
77
75
 
78
76
  ### Running from a terminal
79
77
 
80
78
  Alternatively, from a terminal you can run this module as:
81
79
  ```
82
- tapps --tpf tpf_file
83
- python3 -m tessapps --tpf tpf_file
80
+ tapps --tpf star_tpf
81
+ python3 -m tessapps --tpf star_tpf
84
82
  ```
85
83
 
86
- More about usage information in [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/usage).
87
-
88
84
  ## Authors
89
85
 
90
86
  Leonidas Liponis
@@ -104,8 +100,6 @@ No LLMs were used in the making of this project. All code was generated and veri
104
100
  ## To-Do list
105
101
 
106
102
  - add description
107
- - specify dependencies' versions
108
- - add options to run the module
109
103
  - redo the examples since they reference the flux instead of the contamination factor
110
104
  - add the scoring function
111
105
  - add more stuff in this to-do list
@@ -10,7 +10,7 @@ A python module that calculates a contamination factor in the aperture region of
10
10
  <img src="https://codeberg.org/leolip128/tessapps/raw/branch/main/documentation/examples/images/HAT-P-1.png" alt="HAT-P-1 example" style="width:63.21%; height:auto;">
11
11
  </p>
12
12
 
13
- Full documentation is available [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/). Below is some useful information, taken from the documentation.
13
+ Full documentation is available [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/README.md). Below is some useful information, taken from the documentation.
14
14
 
15
15
  ## Installation
16
16
 
@@ -23,17 +23,15 @@ Full documentation is available [here](https://codeberg.org/leolip128/tessapps/s
23
23
  - ```matplotlib``` (>=3.5): to plot the result (shows aperture mask with a caption at the bottom)
24
24
  - ```lightkurve``` (>=2.0): to fetch and load tpf files
25
25
 
26
- Python >=3.10 is required. More information about dependencies can be found [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/installation).
26
+ Python >=3.10 is required. More information about dependencies can be found [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/installation/README.md).
27
27
 
28
- ### How to install
29
-
30
- Run ```pip install tessapps```.
28
+ Install with ```pip install tessapps```.
31
29
 
32
30
  ## Running the module
33
31
 
34
32
  ### Running from a notebook
35
33
 
36
- A tpf is needed to run this module. If no tpf is supplied, the default is a file with HAT-P-1 (the example picture above). So, here is the minimal example:
34
+ A tpf is needed to run this module. If no tpf is supplied, the default is a file with HAT-P-1 (the example picture above). Here is the minimal example:
37
35
  ```
38
36
  import tessapps
39
37
 
@@ -42,30 +40,28 @@ tessapps.run()
42
40
  >>> [0.57675, 0.00191]
43
41
  ```
44
42
 
45
- The first number is the contamination factor, and the second is its error. Here is a more realistic example with CoRoT-1 (also in the example images):
43
+ The first number is the contamination factor, and the second is its error. Here is a more realistic example:
46
44
 
47
45
  ```
48
- import lightkurve as lk
49
46
  import tessapps as tapps
47
+ from tessapps.search_parameters_to_tpf import find_tpf
50
48
 
51
- CoRoT_1_tpf = lk.search_targetpixelfile('CoRoT 1')[1].download()
52
- contamination, error = tapps.run(CoRoT_1_tpf, result=True)
49
+ tpf = find_tpf(TIC=346338552, mission="TESS", sector=84, exptime=120) # HAT-P-1
50
+ contamination, error = tapps.run(tpf, result=True)
53
51
 
54
- >>> The background contributes (2.249 ± 0.020)% of the total flux in the aperture region.
52
+ >>> The background contributes (57.675 ± 0.191)% of the total flux in the aperture region.
55
53
  ```
56
54
 
57
- This means that the contamination factor is 0.02249 ± 0.00020 (rounded).
55
+ More information about usage in [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/usage/README.md).
58
56
 
59
57
  ### Running from a terminal
60
58
 
61
59
  Alternatively, from a terminal you can run this module as:
62
60
  ```
63
- tapps --tpf tpf_file
64
- python3 -m tessapps --tpf tpf_file
61
+ tapps --tpf star_tpf
62
+ python3 -m tessapps --tpf star_tpf
65
63
  ```
66
64
 
67
- More about usage information in [here](https://codeberg.org/leolip128/tessapps/src/branch/main/documentation/usage).
68
-
69
65
  ## Authors
70
66
 
71
67
  Leonidas Liponis
@@ -85,8 +81,6 @@ No LLMs were used in the making of this project. All code was generated and veri
85
81
  ## To-Do list
86
82
 
87
83
  - add description
88
- - specify dependencies' versions
89
- - add options to run the module
90
84
  - redo the examples since they reference the flux instead of the contamination factor
91
85
  - add the scoring function
92
86
  - add more stuff in this to-do list
@@ -13,7 +13,7 @@ requires-python = ">=3.10"
13
13
  dependencies = ["numpy>=1.21.2", "scipy>=1.7.2", "astropy>=5.0", "astroquery>=0.4.6", "matplotlib>=3.5", "lightkurve>=2.0"]
14
14
 
15
15
  [tool.bumpversion]
16
- current_version = "0.3.0"
16
+ current_version = "0.3.2"
17
17
  commit = false
18
18
  tag = false
19
19
  allow_dirty = true
@@ -2,5 +2,5 @@
2
2
 
3
3
  from tessapps.main import run
4
4
 
5
- __version__ = "0.3.0"
5
+ __version__ = "0.3.2"
6
6
  __all__ = ["run"]
File without changes
File without changes