pryngles 0.7.3

PlanetaRY spanGLES: the bright-side of the light-curve of (ringed) exoplanets

Pryngles

PlanetaRY spaNGLES

Pryngles is a Python package intended to produce useful visualizations of the geometric configuration of a ringed exoplanet (an exoplanet with a ring or exoring for short) and more importantly to calculate the light curve produced by this kind of planets. The model behind the package has been developed in an effort to predict the signatures that exorings may produce not only in the light curve of transiting exoplanets (a problem that has been extensively studied) but also in the light of stars having non-transiting exoplanets (the bright side of the light curve).

This is an example of what can be done with Pryngles:

For the science behind the model please refer to the following papers:

Zuluaga, J.I., Sucerquia, M. & Alvarado-Montes, J.A. (2022), The bright side of the light curve: a general photometric model for non-transiting exorings, Astronomy and Computing 40 (2022) 100623, arXiv:2207.08636.

Sucerquia, M., Alvarado-Montes, J. A., Zuluaga, J. I., Montesinos, M., & Bayo, A. (2020), Scattered light may reveal the existence of ringed exoplanets. Monthly Notices of the Royal Astronomical Society: Letters, 496(1), L85-L90.

Download and install

pryngles is available in PyPI, https://pypi.org/project/pryngles/. To install it, just execute:

   pip install -U pryngles

If you prefer, you may download and install from the sources.

Quick start

Import the package and some useful utilities:

import pryngles as pr
from pryngles import Consts

NOTE: If you are working in Google Colab before producing any plot please load the matplotlib backend:

%matplotlib inline

Any calculation in Pryngles starts by creating a planetary system:

sys=pr.System()

Then we add objects to the planetary system using:

S=sys.add(kind="Star",
          physics=dict(radius=Consts.rsun/sys.ul),
          optics=dict(limb_coeffs=[0.65])
         )
P=sys.add(kind="Planet",primary=S,
          orbit=dict(a=0.2,e=0.0),
          physics=dict(radius=Consts.rsaturn/sys.ul)
         )
R=sys.add(kind="Ring",primary=P,
          physics=dict(fi=1.5,fe=2.5,i=30*Consts.deg)
         )
O=sys.add(kind="Observer",
          optics=dict(lamb=90*Consts.deg,beta=90*Consts.deg)
         )

In the example before the planet has a ring extending from 1.5 to 2.5 planetary radius which is inclined 30 degrees with respect to the orbital plane. It has an orbit with semimajor axis of 0.2 and eccentricity 0.0.

Once the system is set we can ensamble a simulation, ie. creating an object able to produce a light-curve.

RP=sys.ensamble_system()

To see how the surface of the planet and the rings looks like run:

RP.plotRingedPlanet()

You may change the position of the star in the orbit and see how the appearance of the planet changes:

RP.changeStellarPosition(45*Consts.deg)
RP.plotRingedPlanet()

Below is the sequence of commands to produce your first light curve:

import numpy as np
RP.changeObserver([90*Consts.deg,30*Consts.deg])
lambs=np.linspace(+0.0*Consts.deg,+360*Consts.deg,100)
Rps=[]
Rrs=[]
ts=[]
for lamb in lambs:
    RP.changeStellarPosition(lamb)
    ts+=[RP.t*sys.ut/Consts.day]
    RP.updateOpticalFactors()
    RP.updateDiffuseReflection()
    Rps+=[RP.Rip.sum()]
    Rrs+=[RP.Rir.sum()]

ts=np.array(ts)
Rps=np.array(Rps)
Rrs=np.array(Rrs)

#Plot
import matplotlib.pyplot as plt
fig=plt.figure()
ax=fig.gca()
ax.plot(ts,Consts.ppm*Rps,label="Planet")
ax.plot(ts,Consts.ppm*Rrs,label="Ring")
ax.plot(ts,Consts.ppm*(Rps+Rrs),label="Planet+Ring")

ax.set_xlabel("Time [days]")
ax.set_ylabel("Flux anomaly [ppm]")
ax.legend();

And voilà!

Let's have some Pryngles.

Tutorials

We have prepared several Jupyter tutorials to guide you in the usage of the package. The tutorials evolve as the package is being optimized.

• Quickstart [Download, Google Colab]. In this tutorial you will learn the very basics about the package.

• Developers [Download, Google Colab]. In this tutorial you will find a detailed description and exemplification of almost every part of the package. It is especially intended for developers, however it may also be very useful for finding code snippets useful for science applications. As expected, it is under construction as the package is being developed.

Examples

Working with Pryngles we have created several Jupyter notebooks to illustrate many of its capabilities. In the examples below you will find the package at work to do actual science:

• Full-science exploration [Download, Google Colab]. In this example we include the code we used to generate the plots of the release paper arXiv:2207.08636 as a complete example of how the package can be used in a research context.

Disclaimer

This is the disco version of Pryngles. We are improving resolution, performance, modularity and programming standards for future releases.

What's new

• 0.7.x versions:

  • All changes from the 0.6.1.x tests were assumed.
  • The code was refactored to make it more modular.
  • In the new version of the code we have made public a complete notebook illustrating the use of the package for producing light-curves of scientific uses (pryngles-examples-exploration.ipynb).
  • New class, Spangler, intented to sample with a Fibonacci distribution of points the surface of spheres and disks. In the RingedPlanet interface of Pryngles the Spangler class correspond to the class Sample.
  • The spangler class have been implemented to a point of creating multiple spanglers in a single one.
  • We add the capability to preview spangles with the Spangler methods.
  • New classes introduced: Spangle.
  • New methods introduced in body class: spangle_body.
  • A new tutorial for developers have been added.

• 0.6.x versions:

  • 0.6.0 is the official release version, after paper acceptance and arXiv submission.
  • File version.py included.
  • Link to quickstart tutorial in Google Colab, updated.
  • Updated information about paper in the arXiv and ACL code.

• 0.5.x versions:

  • Preview method plotRingedPlanet modified to work under Google Colab.
  • Physical and astronomical constants included.
  • A new tutorial was included.
  • A major update in the classes to create and populate planetary system.

• 0.4.x versions:

  • A new model to create and populate planetary system has been implemented.

• 0.3.x versions:

  • A water mark with version number included.
  • Version is now available in the version variable.
  • Scattering formulae tested and verified.
  • Package has been compared against similar packages (good agreement) but disclaimer has been done.
  • New version number scheme: 0.x.y (x-major, y-minor release), 0.x.y.z (z test version).
  • Major corrections in diffuse formulae.

• 0.2.1.x versions:

  • Tutorial is now working in Google Colab.
  • References were corrected.
  • The home url was set as the PyPI web page.
  • Non-linear (4th order) limb darkening included.
  • Added the class Extra.
  • Function to draw logo: drawPryngles.
  • Added function prynglesMark.
  • Now __version__ variable is available.

• 0.2.0.x versions:

  • First official version of the package.

Test versions

These are the improvements coming in the next releases of the package. Improvements in the 0.6.1.x test versions will be released in the 0.7.x official versions.

• 0.6.1.x versions:

  • This is branch refactor.
  • We have refactor the package to make it much more modular.
  • The previous version (RingedPlanet interface) have been preserved in the legacy module.

• 0.7.0.x versions:

  • New.

---

This package has been designed and written originally by Jorge I. Zuluaga, Mario Sucerquia & Jaime A. Alvarado-Montes (C) 2022