Published February 14, 2024
| Version v0.5.1
Software
Open
TidalPy
Description
TidalPy
**Tidal Dynamics and Thermal-Orbital Evolution Software Suite Implemented in Cython and Python**
TidalPy is an open-source software suite that utilizes a semi-analytic approach to estimate tidal heating,
orbit-rotation evolution, and thermal changes for rocky and icy worlds. It has been used to simulate the thermal-orbital
evolution of moons within our Solar System as well as exoplanets beyond. TidalPy's `RadialSolver` package can accurately
estimate the viscoelastic Love and Shida numbers for a multi-layered world, including the effects of liquid layers,
compressibility, dynamic tides, and advanced rheological models. This model has been used to study the tidal response
of Mercury, Venus, Earth, our Moon, and Mars.
Have any questions? Feel free to leave an [issue](https://github.com/jrenaud90/TidalPy/issues) or send a message to
[TidalPy@gmail.com](mailto:tidalpy@gmail.com).
Related Software
Below is a non-exhaustive list of publicly available software that perform similar or parallel calculations as TidalPy.
* Are you interested in the habitability of a planet? With considerations of tides, atmospheres, water content, solar
interactions? Check out...
* [VPLanet](https://github.com/VirtualPlanetaryLaboratory/vplanet)
* Are you interested in the orbital evolution of multiple planets with each planet influencing one another? Consider an
N-body approach like...
* [Posidonius (formerly Mercury-T)](https://github.com/marblestation/posidonius)
* [ReboundX](https://github.com/dtamayo/reboundx)
* Don't care about tides or orbital dynamics but are instead interested in interior structure and composition of
planets?
* [BurnMan](https://github.com/geodynamics/burnman)
* [PerpleX](http://www.perplex.ethz.ch/)
* Are you interested in tides, interiors, *and* the chemical evolution of small worlds but don't care about
non-synchronous rotation or compressibility of planets?
* [IcyDwarf](https://github.com/MarcNeveu/IcyDwarf)
However, if you want high fidelity tidal, orbital, spin, and interior models --- then you have come to the right place!
Read below for instructions on how to install and use TidalPy.
How to Install
Compatibility
*As of TidalPy v0.5.0*:
* **Windows-Latest**: *Installation & tests passed.*
* **MacOS-Latest**: *Installation & tests passed.*
* **Ubuntu-Latest**: *Installation & tests passed.*
Basic Installation
Installing TidalPy is ass simple as ensuring 64-bit [Python 3.9+](https://www.python.org/) is installed on your
system and performing the following in a terminal:
`pip install TidalPy`
_TidalPy can not currently be installed via `conda install`._
How to Use TidalPy
Check out the `Documentation\Getting Started.md` file. This is pretty bare bones at the moment but offers some basic
info about TidalPy. For now the best way to learn how to use TidalPy is by checking out the `Demos` directory. There
are "beginner" [Jupyter notebooks](https://jupyter.org/) that are a great starting point.
Using TidalPy for Science
TidalPy has been used in several studies already, and we encourage you to use it in yours. We would appreciate you
include a link back to this [page](https://github.com/jrenaud90/TidalPy) and cite one of the papers discussed in
the next section. We also would love to see where TidalPy is being used! Please feel free to send us an
email: [TidalPy@gmail.com](mailto:TidalPy@gmail.com) when a paper or presentation utilized TidalPy. Anyone is welcome to
make forks or copies of TidalPy as long as their work references back to this page. License information can be found at
the end of this file.
Citing TidalPy
If you use TidalPy for your research please cite its Zenodo [doi: 10.5281/zenodo.7017474](https://zenodo.org/records/7017560).
The science used in TidalPy is described in the following papers and software (and references therein):
* Rheological Modeling Package:
* [Tidally Heated Terrestrial Exoplanets: Viscoelastic Response Models](https://ui.adsabs.harvard.edu/abs/2009ApJ...707.1000H/abstract)
* [Increased Tidal Dissipation Using Advanced Rheological Models](https://ui.adsabs.harvard.edu/abs/2018ApJ...857...98R/abstract)
* Non-synchronous Rotation Evolution and High Eccentricity Truncation Packages:
* [Tidal Dissipation in Dual-Body, Highly Eccentric, and Non-synchronously Rotating System](https://ui.adsabs.harvard.edu/abs/2021PSJ.....2....4R/abstract)
* [Tidal Evolution of the Keplerian Elements](https://ui.adsabs.harvard.edu/abs/2019CeMDA.131...30B/abstract)
* Third Party Software:
* *Interior Model*: [BurnMan](https://github.com/geodynamics/burnman)
* *Integration Routines*: [CyRK](https://zenodo.org/records/8329446)
* *CVD Conscious Color Maps*: [Geodynamic Color Maps](http://doi.org/10.5281/zenodo.5501399)
* *Projection Maps*: [Cartopy](https://scitools.org.uk/cartopy/docs/latest/)
* *Exoplanet data*: [Astroquery](https://github.com/astropy/astroquery/blob/main/astroquery/CITATION), [AstroPy](https://www.astropy.org/acknowledging.html)
Acknowledgements
TidalPy was partially developed with support from NASA Goddard Space Flight Center's
Sellers Exoplanet Environments Collaboration (SEEC) and Geodesy ISFM.
TidalPy is partially based upon work supported by NASA under award number 80GSFC21M0002 and the
Center for Research and Exploration in Space Science & Technology II (CRESST II) administered at the University of
Maryland, College Park.
TidalPy has been improved by numerous contributors some of which you can find [here](https://github.com/jrenaud90/TidalPy/graphs/contributors).
TidalPy has benefited from work and conversations with the following:
- Wade G. Henning (U. of Maryland, College Park / NASA GSFC)
- Sander Goossens (NASA GSFC)
- Marc Neveu (U. of Maryland, College Park / NASA GSFC)
- Gael Cascioli (U. of Maryland, Baltimore County / NASA GSFC)
Notes
Support provided by:
NASA Habitable Worlds Program, NNH16ZDA001N-HW
NASA ISFM Sellers' Exoplanet Environments Collaboration
CRESST II Cooperative Agreement NASA Award 80GSFC21M0002
Files
TidalPy-main.zip
Files
(4.8 MB)
| Name | Size | Download all |
|---|---|---|
|
md5:0605d9c9fb9800ac21b70c40a917b30f
|
4.8 MB | Preview Download |
Additional details
Related works
- Is documented by
- Software: https://github.com/jrenaud90/TidalPy (URL)
Dates
- Updated
-
2024-02-14TidalPy v0.5.1
Software
- Repository URL
- https://github.com/jrenaud90/TidalPy
- Programming language
- Python, Cython, C