Obliqua (Tidal heating model)

A Julia package to calculate the tidal deformation (i.e., tidal Love numbers) of solid, partially-solid, and liquid planetary mantles and the associated volumetric tidal dissipation and global heating rates.

Documentation

Obliqua: https://proteus-framework.org/Obliqua/ PROTEUS: https://proteus-framework.org/PROTEUS/

Repository structure

• README.md - This file
• CODE_OF_CONDUCT.md - Code of conduct for the community
• LICENSE.txt - License for modification, distribution, etc.
• Project.toml - Project file for Julia package manager
• src/ - Source files
• docs/ - Documentation files
• out/ - Output files
• res/ - Resources
• test/ - Tests for the code
• examples/ - Tools and notebooks showing how to use the code

Source code

GitHub: https://github.com/FormingWorlds/Obliqua

This software is available under the MIT license. Different components within the PROTEUS framework carry different licenses. Please find information about the use of licenses within the PROTEUS framework on the PROTEUS licence page.

Installation

1. Install Julia's package manager (Mac and Linux):

   curl -fsSL https://install.julialang.org | sh

2. Clone the repo

   git clone https://github.com/FormingWorlds/Obliqua.git

3. Move to the repository directory

   cd Obliqua

4. Open Julia package manager

   julia

5. Install Obliqua

   julia> ]
   pkg> add .

Integrations

This project is being developed in close collaboration with the PROTEUS similation framework. Obliqua can be used seamlessly within PROTEUS to model tidal dissipation and Love number evolution in planetary interiors.

For detailed instructions on installing and using Obliqua in combination with PROTEUS, please refer to the installation guide in the Obliqua documentation.