Metadata-Version: 2.1
Name: PyALMA3
Version: 1.0.0
Summary: Python plAnetary Love nuMbers cALculator
Home-page: https://github.com/drsaikirant88/PyALMA3
Author: Marshall J. Styczinski, Saikiran Tharimena, Daniele Melini, Giorgio Spada, Steven D. Vance
Author-email: itsmoosh@gmail.com
Project-URL: Bug tracker, https://github.com/drsaikirant88/PyALMA3/issues
Project-URL: Publication, https://doi.org/10.1093/gji/ggac263
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.26.3
Requires-Dist: mpmath >=1.3.0
Requires-Dist: psutil >=5.9.7
Requires-Dist: joblib >=1.3.2
Requires-Dist: toml >=0.10.2

# Python plAnetary Love nuMbers cALculator
PyALMA3 is a pythonized version of ALMA 3. This software package calculates tidal Love numbers given an appropriate model of interior structure for a planetary body.

## Installation

The recommended installation method is with pip:

`pip install PyALMA3`

After installing with pip, copy over the default config file to your working directory with

`python -m alma`

Then to compute Love numbers, call PyALMA3 functions using e.g.

```
from alma import love_numbers

h, l, k = love_numbers(n, t, 
                       alma_params['mode'], 
                       alma_params['function'],
                       alma_params['tau'],
                       model_params,
                       alma_params['type'],
                       alma_params['gorder'],
                       verbose = alma_params['verbose'],
                       parallel = alma_params['parallel'])
```

See [PP_example.ipynb](https://github.com/drsaikirant88/PyALMA3/blob/main/PP_example.ipynb) for a complete example application.

## Disclaimers and copyright

PyALMA3 is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 or any later version.

PyALMA3 is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

GNU GPL: http://www.gnu.org/licenses/

Authors: Saikiran Tharimena, Daniele Melini, Giorgio Spada, Steven D. Vance, Marshall J. Styczinski

Copyright (C) 2024 the authors.
