From 83fd2feb53021391752dfc4d11b135d212054cc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Federico=20Garc=C3=ADa?= <39309065+garciafederico@users.noreply.github.com> Date: Tue, 8 Aug 2023 09:04:28 -0300 Subject: [PATCH] Update README.md --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3c91c8b..6180b72 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ -## pyXspecCorner by Federico Garcia +## py(tk)XspecCorner by Federico Garcia A Python tool to make interactive [Corner Plots](https://corner.readthedocs.io/) based on XSPEC MCMC chains saved to FITS files. -![screenshot](screenshot.png) +![screenshot tkXspecCorner.py](screenshot_tk.png) and/or -![screenshot](screenshot_tk.png) +![screenshot pyXspecCorner.py](screenshot.png) ### Description: -The program will open two matplotlib windows, one with a corner plot and another one with a list of CheckButtons and TextBoxes to interactively select the parameters to be plotted in the corner plot, and edit the individual titles/labels shown in the plot. +The program will open two `matplotlib` windows, one with a corner plot and another one with a list of `CheckButtons` and `TextBoxes` to interactively select the parameters to be plotted in the corner plot, and edit the individual titles/labels shown. -The three last CheckButtons in the list allows to turn on and off the smoothed 2D `contours` in the [Corner Plot](https://corner.readthedocs.io/), and to play with `Titles` and `XYlabels` in the plot. +The three last `CheckButtons` in the list allow to turn on and off the smoothed 2D `contours` in the [Corner Plot](https://corner.readthedocs.io/), and to play with `Titles` and `XYlabels` in the plot. The program also displays a summary with the main statistics of the available parameters in the chain file using the samples selected by the user. +In the `tkinter` version, a `tk` window is opened with `buttons` and `textboxes` for every parameter, a `matplotlib` plot embedded, and a button to Update the plot when needed. + ### Usage: **Basic:** The user must provide the `path/name` to the MCMC XSPEC chain FITS file. @@ -40,10 +42,3 @@ to get a faster version based on `tkinter`. python pyXspecCorner.py -h ``` -### Description: - -The program will open two matplotlib windows, one with a corner plot and another one with a list of CheckButtons to interactively select the parameters to be plotted in the corner plot, and edit the individual titles/labels shown in the plot. - -The three last CheckButtons in the list allows to turn on and off the smoothed 2D contours in the [Corner Plot](https://corner.readthedocs.io/), and to play with Titles and XYlabels in the plot. - -In the `tkinter` version, a `tk` window is opened with buttons and textboxes for every parameter, a `matplotlib` plot embedded, and a button to Update the plot when needed.