Installation

Using pip

You can install the most recent stable version of SysSimPyPlots using pip:

python -m pip install syssimpyplots

From source

All of the code is publicly available on Github. Thus an alternative to pip is to download or clone the repository and install it from there:

git clone https://github.com/hematthi/SysSimPyPlots.git
python -m pip install .

There are multiple ways of cloning; if you have trouble with the above or prefer another, see this Github guide. You should also fork the repository first if you want to make your own changes to the source code later.

Downloading simulated catalogs

After you have installed SysSimPyPlots, you will still need to download some simulated catalogs in order to explore any models. You can download a single, representative catalog generated from the latest model (the “maximum AMD model” described in He et al. 2020) using this link.

Note

This simulated catalog contains five times as many stars as the Kepler catalog in our sample, and is about 450 MB in size.

If you want to perform more robust analyses, you can download many more simulated catalogs from the SysSimExClusters Simulated Catalog folder.

Note

This folder contains 100 individual catalogs, each with the same number of stars as the Kepler catalog in our sample. The total file size is about 3.5 GB compressed, and roughly 8.2 GB when opened/uncompressed.

More details are provided in the SysSimExClusters repository. Check the READMEs of the individual branches for each paper.

That’s it – you are now ready to use SysSimPyPlots!

Dependencies

SysSimPyPlots has been tested on Python >3.7 and uses:

  • numpy (for almost everything)

  • matplotlib (for making plots)

  • scipy (for some miscellaneous functions)

  • corner.py (for plotting multi-dimensional parameter spaces; see how to install)

If you want to go further

If you want to simulate even more additional or new catalogs, you will need to download Julia and install SysSimExClusters which also requires installing ExoplanetsSysSim. Please check those pages for instructions.