property_profile
- tulips.tulips.property_profile(m, time_ind=- 1, property_name='logRho', num_rings=- 1, raxis='mass', log=False, log_low_lim=1e-20, fps=10, fig=None, ax=None, show_time_label=True, time_label_loc=(), time_unit='Myr', fig_size=(5.5, 4), axis_lim=- 99, axis_label='', show_colorbar=True, cmap='plasma', cmin=0, cmax=0, cbar_label='', theta1=0, theta2=360, hrd_inset=True, show_hrd_ticks_and_labels=False, show_total_mass=True, show_surface=True, show_grid=False, output_fname='property_profile', anim_fmt='.mp4')[source]
Create property profile diagram.
Represent the model of a stellar object as circle with radius raxis. The circle is divided into rings whose color reflect the values of a physical property of the model. Requires MESA profile files that contain this property and the corresponding MESA history file.
- Parameters
- mmesaPlot object
Already loaded a history file
- time_indint or tuple (start_index, end_index, step=1) or (start_index, end_index, step)
If int: create the plot at the index time_ind. If tuple: create an animation from start index to end index with intervals of step.
- property_namestring
Property of a MESA profile to be shown as colors.
- num_ringsint
Default -1, if greater than -1, limit the number of rings to this number.
- raxisstr
Default axis to use as radius of the circle.
- logboolean
If set, show the natural logarithm of the property.
- log_low_limfloat
Value to replace zero and negative values in a property with
- fpsint
Number of frames per second for the animation.
- figFigure object
If set, plot on existing figure.
- axAxes object
If set, plot on provided axis.
- show_time_labelboolean
If set, insert a label that gives the age of the stellar object (in Myr).
- time_label_loctuple
Location of the time label on the plot as fraction of the maximal size.
- time_unitstr
Valid astropy time unit, default Myr.
- fig_sizetuple
Size of the figure in inches.
- axis_limfloat
Value to set for the maximum limit of the x and y axis.
- axis_labelstr
Label of the x and y axis.
- show_colorbarboolean
If set, add a colorbar corresponding to the property shown.
- cminfloat
Minimum value to set for the colorbar.
- cmaxfloat
Maximum value to set for the colorbar, if smaller or equal to cmin, use the minimum and maximum values of property_name instead.
- cmapstr or matplotlib.colors.ListedColormap
Colormap to use for the property
- cbar_labelstr
Label to set for the colorbar.
- theta1int or float
Start angle for the wedge.
- theta2int or float
End angle for the wedge.
- hrd_insetboolean
If set, add an inset HRD where the location of the current model is indicated with a circle.
- show_hrd_ticks_and_labelsBoolean
If set, display the axis ticks and labels of the inset HRD
- show_total_mass: boolean
Default False, display the value of the total mass of the model below the circle
- show_surfaceboolean
Default True, if set, show the outer boundary of the stellar object.
- show_gridboolean
Default False, if set, add additional axes in crosshair form.
- output_fnamestr
Name of the output file.
- anim_fmtstr
Format to use for saving an animation.
- Returns
- fig, ax