synthpop.modules.evolution.mist
===============================

.. py:module:: synthpop.modules.evolution.mist

.. autoapi-nested-parse::

   This module provides the loading and handling of MIST isochrones.
   It automatically downloads the isochrone form the online MIST service.

   MIST documentation: https://waps.cfa.harvard.edu/MIST/

   MIST papers: Dotter (2016), Choi et al. (2016);
   DOIs: 10.3847/0067-0049/222/1/8, 10.3847/0004-637X/823/2/102

   The mist_columns.json file provides a guide to which isochrone files include which columns/filters.



Classes
-------

.. autoapisummary::

   synthpop.modules.evolution.mist.MIST


Module Contents
---------------

.. py:class:: MIST(columns, use_global=True, **kwargs)

   Bases: :py:obj:`synthpop.modules.evolution._evolution.EvolutionIsochrones`, :py:obj:`synthpop.modules.evolution.charon_interpolator.CharonInterpolator`


   MIST Isochrone class

   Attributes
   ----------
   FOLDER : location to store the isochrones

   isochrones : dict

   min_mass :

   max_mass :

   met_to_file_iso :

   none_mag_cols :

   file_met :

   bands :

   iso_ages :

   mass_range :


   Methods
   -------
   __init__(self, chosen_bands, iso_props, use_global=False) : None

   get_mass_ranges(isochrones) :  dict
       estimate the mass range for each metallicity age

   convert_to_met(file_isochrones) : ndarray

   load_isochrones(self, magsys) : dict

   convert_to_cmd_to_h5(filename) : pandas.DataFrame
       convert the ascii file to an .h5 file
       Returns the loaded table

   download_isochrones(self, magsys_name) : None
       Download the isochrone system and unpack them


   .. py:attribute:: FOLDER
      :value: "b'.'/data/isochrones/mist"



   .. py:attribute:: max_mass
      :value: 250



   .. py:attribute:: min_mass
      :value: 0.1



   .. py:attribute:: isochrones_name
      :value: 'MIST'



   .. py:attribute:: met_to_file_iso


   .. py:attribute:: file_met


   .. py:attribute:: isochrones_grouped


   .. py:attribute:: iso_ages


   .. py:attribute:: mass_range


   .. py:method:: get_mag_systems(columns)
      :staticmethod:


      Parameters
      ----------
      columns : list
          list specifying columns and filter systems from the MIST Isochrones
      Returns
      -------
      collected_magsys : dict
          Contains the columns for each needed filter system
      none_mag_cols : list
          a list of all non-magnitude columns
      all_bands : list
          a list of all magnitude columns



   .. py:method:: get_mass_ranges(isochrones_grouped)
      :staticmethod:


      Estimate the mass range for each metallicity and age
      Parameters
      ----------
      isochrones_grouped : pandas.DataFrameGroupeBy

      Returns
      -------
      mass_ranges : pandas.DataFrame
          mass range for each age and metallicity



   .. py:method:: convert_to_met(file_isochrones)
      :staticmethod:



   .. py:method:: get_filenames(magsys, met_string)


   .. py:method:: load_isochrones(magsys)

      load the isochrones for each of the given magnitude systems and all metallicities
      if needed it will download the isochrones from the server

      Parameters
      ----------
      magsys : list
          list of magnitude systems.

      Returns
      -------
      isochrones : dict
          dictionary of separate PandasDataFrames for each metallicity.



   .. py:method:: get_columns(filename)
      :staticmethod:



   .. py:method:: read_csv(filename)
      :classmethod:



   .. py:method:: convert_to_cmd_to_h5(filename)
      :classmethod:


      convert the MIST isochrones from an ascii table into a Hierarchical Data Format file (.h5)
      Parameters
      ----------
      filename : str
          filename of the ascii file

      Returns
      -------
      table : pandas.DataFrame
          isochrone table



   .. py:method:: download_isochrones(magsys_name)

      Download the MIST isochrones from the Server

      Parameters
      ----------
      magsys_name : string
          magnitude system
      Returns
      -------