Skip to content

vsquicciarini/madys

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Manifold Age Determination for Young Stars (MADYS)

Description

This repository hosts the code of MADYS: the Manifold Age Determination for Young Stars, a flexible Python tool for parameter determination of young stellar and substellar objects.

MADYS automatically retrieves and cross-matches photometry from several catalogs, estimates interstellar extinction, and derives parameter (age, mass, radius, Teff, logg, logL) estimates for individual objects through isochronal fitting.

Harmonising the heterogeneity of publicly-available isochrone grids, the tool allows to choose amongst several models, many of which with customisable astrophysical parameters. Particular attention has been dedicated to the categorization of these models, labeled through a four-level taxonomical classification.

At the moment of writing, MADYS includes 20 models, 140 isochrone grids, and more then 250 photometric filters (a thorough description of each of them is provided). However, despite our efforts, the model list is far from being complete. If you wish a new model to be included in a new version of MADYS, or a new set of photometric filters to be added to the current list, feel free to get in contact with us.

Five classes are defined to handle a large variety of possible applications, spanning from the characterization of directly-imaged planets to the study of stellar associations. Notably, large direct imaging survey will benefit from MADYS' capability to compute planetary masses corresponding to detection limits of direct imaging observations.

Finally, several dedicated plotting functions are included to allow a visual perception of the numerical output.

Latest news:

Apr 28, 2024 - Version v1.3.0 published! Expanded the features of the CurveObject class; added Hipparcos catalog and Gaia DR3-Hipparcos proper motion to the automatic ADQL query done by SampleObject; increased completeness of catalog cross-matches; improved readability of code following Docstring Conventions (PEP 8).

Jan 22, 2024 - Version v1.2.0 published! A more accurate parameter derivation was introduced when providing [age_opt, age_min, age_max] triplets; SampleObject instances can now be merged; a higher degree of control of plotting options is now possible; fixed minor bugs.

Oct 18, 2023 - Version v1.1.0 published! Several new functionalities added: a class to handle the conversion of direct imaging contrast curves into mass curves; functions to easily export/import SampleObject and FitParams instances; a new attribute of SampleObject containing information on photometric quality. Better exploitation of log files; better handling of output files and objects; general improvement of computational performances.

Oct 10, 2023 - MADYS has now a full documentation on readthedocs. Have a look at it!

Sep 09, 2023 - Version v1.0.0 published! Newly added models: Dartmouth (magnetic and non-magnetic, Feiden 2016), solar-metallicity PARSEC v2.0 (Nguyen et al. 2022), latest version of ATMO (Chabrier et al. 2023); added JWST filters to PARSEC (v1.2 and v2.0) isochrones, and Gaia, 2MASS, Panstarrs and HST filters to ATMO 2020. Inserted possibility to estimate synthetic photometry for fitted objects in bands not employed when deriving their parameters.

Feb 17, 2023 - Changed default queried catalog from Gaia DR2 to Gaia DR3 when providing a list of stars with non-Gaia identifiers (i.e., with 'id_type'='other').

Jan 19, 2023 - Added the possibility to take into account uncertainties on E(B-V) values, which can now be provided at inizialization through a dedicated keyword 'ebv_err'.

Aug 03, 2022 - Sloan Digital Sky Survey added to the list of automatically searchable surveys. Its filters are now available with the following models: PARSEC, MIST, AMES-Dusty, AMES-Cond, BT-Settl, NextGen.

Jun 20, 2022 - BEX models (Linder et al. 2019, Marleau et al. 2019) added to the list of available models.

Jun 17, 2022 - Gaia DR3 now available! The new catalog replaces, for all intents and purposes, Gaia EDR3.

Installation:

Catalog queries are mediated by the TAP Gaia Query package (tap). If you import madys from the command line, the module is automatically installed if not found. However, this does not work from Jupyter Notebook. We suggest to manually install the package from pip, through:

pip install git+https://github.com/mfouesneau/tap

Please make sure you use the command above, as just using pip install tap will download a different, although eponymous, package.

Note that TAP Gaia Query might require the installation of lxml (v4.6.3).

Once TAP Gaia Query is installed, the current MADYS repository can be installed using pip:

pip install madys

Note that, when using for the first time an extinction map, MADYS will download the relevant file (0.7 GB or 2.2 GB, depending on the map).

Requirements

This package relies on usual packages for data science and astronomy: numpy (v1.18.1), scipy (v1.6.1), pandas (v1.1.4), matplotlib (v3.3.4), astropy (v4.3.1) and h5py (v3.2.1).

In addition, it also requires astroquery (v0.4.2.dev0) and TAP Gaia Query (v0.1). The latter package might require the installation of lxml (v4.6.3).

Examples

The package is fully documented on readthedocs.io:

https://madys.readthedocs.io/en/latest/

and a detailed description of its features, together with several examples of the kind of scientific results that can be obtained with it, is provided in Squicciarini & Bonavita (2022).

We recommend you check out the examples provided and the docs, for a better understanding of its usage.

If you find a bug or want to suggest improvements, please create a ticket.

Recent papers using MADYS:

MADYS has already been employed, starting from its preliminary forms, in several publications, including:

Authors

Vito Squicciarini, LESIA - Observatoire de Paris, FR (vito.squicciarini@obspm.fr)

Mariangela Bonavita, The Open University, UK

We are grateful for your effort, and hope that these tools will contribute to your scientific work and discoveries. Please feel free to report any bug or possible improvement to the authors.

Attribution

Please cite Squicciarini & Bonavita (2022) whenever you publish results obtained with MADYS.