Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arcunique authored Feb 28, 2024
1 parent 884b37f commit e2003b5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Build Status](https://img.shields.io/badge/release-1.0.0-orange)](https://github.com/arcunique/Cplotter)
[![Build Status](https://img.shields.io/badge/release-0.1-orange)](https://github.com/arcunique/Cplotter)
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-371/)

GPS (Genesis Population Synthesis)
Expand All @@ -15,7 +15,7 @@ bulk compositions of the planets and to simulate atmospheric loss and evolution
observationally verified. The code also offers tools to process and analyze the data from recentmost observations of small exoplanets, in
order to compare them with the models. This code has been used to generate results for our paper [Chakrabarty & Mulders 2023]() which
focuses on the enigmatic world of *water planets* and their possible locations. The results shown in the paper can be reproduced by running the Python
scripts placed in the *chakrabarty_mulders_2023* folder. Please refer to the release *1.0.0* to access the version that matches the results.
scripts placed in the *chakrabarty_mulders_2023* folder. Please refer to the release *0.1* to access the version that matches the results.

Follow this for more updates. If you find this code helpful in your work, please cite the following papers:
[Chakrabarty & Mulders 2023]() and [Mulders et al. 2020](https://ui.adsabs.harvard.edu/abs/2020ApJ...897...72M/abstract). The citation details can be found on those links.
Expand All @@ -36,12 +36,12 @@ Requirements

Instructions on installation and use
------------------------------------
Presently, the code is only available on [Github](https://github.com/arcunique/GPS). Download the zip folder, place anywhere, and
Presently, the code is only available on [Github](https://github.com/arcunique/GPS). Download the zip folder, place it anywhere, and
start using.

The code contains classes and functions to perform the different stages of the models. A documentation is underway. Notebooks can be found in the
*example_notebooks* folder which illustrate how to use these classes and functions for different use cases. Although the codebase focuses on the Genesis models,
any other models can easily be integrated with this code. Just ensure that structure of the input file matches with that of the Genesis file.
The code contains classes and functions to perform the different stages of the models. Documentation is underway. Notebooks can be found in the
*example_notebooks* folder which illustrates how to use these classes and functions for different use cases. Although the codebase focuses on the Genesis models,
any other models can easily be integrated with this code. Just ensure that the structure of the input file matches with that of the Genesis file.
The structure is explained in the example notebooks.


Expand Down

0 comments on commit e2003b5

Please sign in to comment.