Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
garciafederico authored Aug 8, 2023
1 parent f579ec2 commit 83fd2fe
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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.

0 comments on commit 83fd2fe

Please sign in to comment.