MATRIX ToolKit

ToolKit for Multi-phAse Transits Recovery from Injected eXoplanets

MATRIX is an injection-recovery software prepared to create grids of scenarios with a set of periods, radii and epochs of synthetic transiting exoplanet signals in a provided light curve. The typical injection-recovery execution has consisted in the usage of 2 dimensional scenarios, where only one epoch (random or hardcoded) was used for each period and radius. Even though this is a fair approach when the computational power is very limited, this reduces the accuracy of the experiment as the recoverability might vary depending on the transit epoch and hence, the places where the transits would appear in the curve. E.g: A transit would be clearly recovered falling in a quite region of the curve but not easy to recover when it happened close to a flare or a curve gap. A multi-phase analysis can now be done with MATRIX easily by only setting a few parameters in a configuration file and running one line of code.

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 files under the example directory.

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

For the complete set of properties available for use please look at the root 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.

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}
}

Documentation

For more information please visit https://tkmatrix.readthedocs.io/.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for Pachoc from gravatar.com Pachoc

Credits

Author: M. Dévora-Pajares & F.J. Pozuelos

License

MIT License

Requires

Python >=3.11

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tkmatrix-0.14.0.tar.gz (3.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tkmatrix-0.14.0-py3-none-any.whl (3.5 MB view details)

Uploaded Python 3

File details

Details for the file tkmatrix-0.14.0.tar.gz.

File metadata

  • Download URL: tkmatrix-0.14.0.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for tkmatrix-0.14.0.tar.gz
Algorithm Hash digest
SHA256 0cb13c4e1d5f48b61f77514c6ca9e0700a07a53d83d97d4760e80dcb27bdb157
MD5 11a3a84531493990b47c108a1b30666e
BLAKE2b-256 bd21e26642d0f386023d3fe2c5c2b5255f58e9e821c7e92031c1807fa08fee64

See more details on using hashes here.

File details

Details for the file tkmatrix-0.14.0-py3-none-any.whl.

File metadata

  • Download URL: tkmatrix-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 3.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for tkmatrix-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eaa892d18d433380b5335112fef63aae3411e1de8724cd370347a40c61eecf8f
MD5 126e3241a62fbc87226391cb2a921c22
BLAKE2b-256 eac55277cf7ee7506c41057d9d0361de2a0e4b0c7aaf00cd7892f6c48193dec2

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.14.0 This release

2 files

0.13.1

2 files

0.13.0

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.7

2 files

0.8.6

2 files

0.8.5

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.0

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.4

2 files

0.4.2

2 files

0.4.1

2 files

0.3.30

2 files

0.3.29

2 files

0.3.26

2 files

0.3.25

2 files

0.3.24

2 files

0.3.21

2 files

0.3.20

2 files

0.3.19

2 files

0.3.17

2 files

Pre-release

0.3.16rc2

2 files

0.3.15

2 files

0.3.14

2 files

0.3.13

2 files

0.3.12

2 files

0.3.11

2 files

0.3.10

2 files

0.3.9

2 files

0.3.8

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.19

2 files

0.2.16

2 files

0.2.15

2 files

0.2.14

2 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.9

2 files

0.1.6

2 files

0.1.5

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page