ctplanet


Namectplanet JSON
Version 0.2.4 PyPI version JSON
download
home_page
SummaryCreate a crustal thickness map of a planet
upload_time2023-05-19 13:41:39
maintainer
docs_urlNone
author
requires_python>=3.8
licenseBSD-3-Clause
keywords crust gravity geophysics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ctplanet
Create crustal thickness maps of planets from gravity and topography.

## Description
ctplanet provides several functions and example scripts for generating crustal thickness maps of a planet from gravity and topography data, and the calculation of hydrostatic relief along density interfaces beneath the lithosphere.

### Methods
`pyMoho`                Calculate relief using a constant density crust and
                        mantle.

`pyMohoRho`             Calculate relief using a constant density mantle and a
                        variable density crust.

`HydrostaticShapeLith`  Calculate the relief of hydrostatic interfaces beneath
                        the lithosphere along with the predicted gravity,
                        taking into account rotation and/or tides using the
                        approach of *Wieczorek et al.* (2019).

`HydrostaticShape`      Calculate the relief of hydrostatic interfaces and
                        predicted gravity of a rotating hydrostatic planet
                        using the approach of *Wieczorek et al.* (2019).


`InertiaTensor_from_shape`  Calculate the inertia tensor given a radial density
                            profile and shape of each interface.

`InertiaTensor_from_C`      Calculate the inertia tensor given the polar moment
                            of inertia and the gravitational potential
                            coefficients.

`moi`                       Calculate the mean, normalized, moment of inertia
                            up to index n.


`ReadRefModel`   Read the reference interior model file.

### Example scripts
`Moon-Crust`   A script that demonstrates how to calculate the thickenss
               of the lunar crust using either a constant or variable density
               crust. The latter can be used to reproduce the results
               presented in *Wieczorek et al.* (2013).

`Moon-Core`      Calculate the hydrostatic relief of the lunar core accounting
                 for the non-hydrostatic potential that comes from the
                 lithosphere.

`Mars-Crust`   A script that demonstrates how to calculate the thickenss
               of the Martian crust using either a constant or variable
               density crust. For the variable density crust, the density is
               assumed to change discontinuously across the dichotomy
               boundary.

`Mars-Crust-hydrostatic-tests`   Create a crustal thickness map of Mars from
                                 gravity and topography and compare how results
                                 change if hydrostatic interfaces are not taken
                                 into account.

`Mars-Crust-InSight`    Create a crustal thickness map of Mars from gravity
                        and topography, using the InSight crustal thickness
                        constraint.

`Mars-Crust-InSight-dichotomy`   Create a crustal thickness map of Mars from
                                 gravity and topography, using the InSight
                                 crustal thickness constraint and different
                                 densities across the dichotomy boundary.

`Mars-fcn`       Compute the free core nutation period of Mars.

`Mars-shape`      Create images related to Mars in *Wieczorek et al.* (2019).

`Mars-j2`        Compute the contribution to the gravitational J2 of Mars from
                 hydrostatic interfaces beneath the lithosphere.

`Earth-shape`     Compute hydrostatic relief of Earth using PREM.

`Ceres-shape`          Calculate the hydrostatic shape of Ceres.

## How to install and run ctplanet

Download the ctplanet repository and install using pip
```bash
    git clone https://github.com/MarkWieczorek/ctplanet.git
    pip install .
```

To execute a script
```bash
    cd examples
    python Moon-Crust.py
```

Depending on how your system is set up, it might be necessary to use explicitly `python3` and `pip3` instead of `python` and `pip` in the above commands.

## Reference

Wieczorek, M. A., G. A. Neumann, F. Nimmo, W. S. Kiefer, G. J. Taylor,
    H. J. Melosh, R. J. Phillips, S. C. Solomon, J. C. Andrews-Hanna,
    S. W. Asmar, A. S. Konopliv, F. G. Lemoine, D. E. Smith, M. M. Watkins,
    J. G. Williams, M. T. Zuber (2013), The crust of the Moon as seen by GRAIL,
    *Science*, 339, 671-675, doi:[10.1126/science.1231530](http://doi.org/10.1126/science.1231530).

Wieczorek, M. A.,  M. Beuthe, A. Rivoldini, and T. Van Hoolst (2019),
    Hydrostatic interfaces in bodies with nonhydrostatic lithospheres,
    *Journal of Geophysical Research: Planets*, 124, doi:[10.1029/2018JE005909](http://doi.org/10.1029/2018JE005909).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ctplanet",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "crust,gravity,geophysics",
    "author": "",
    "author_email": "Mark Wieczorek <mark.wieczorek@ipgp.fr>",
    "download_url": "https://files.pythonhosted.org/packages/f4/b3/7bfacc0b6d44ff2a68f5974e94c174effe0a895eaada2caa676495be8083/ctplanet-0.2.4.tar.gz",
    "platform": null,
    "description": "# ctplanet\nCreate crustal thickness maps of planets from gravity and topography.\n\n## Description\nctplanet provides several functions and example scripts for generating crustal thickness maps of a planet from gravity and topography data, and the calculation of hydrostatic relief along density interfaces beneath the lithosphere.\n\n### Methods\n`pyMoho`                Calculate relief using a constant density crust and\n                        mantle.\n\n`pyMohoRho`             Calculate relief using a constant density mantle and a\n                        variable density crust.\n\n`HydrostaticShapeLith`  Calculate the relief of hydrostatic interfaces beneath\n                        the lithosphere along with the predicted gravity,\n                        taking into account rotation and/or tides using the\n                        approach of *Wieczorek et al.* (2019).\n\n`HydrostaticShape`      Calculate the relief of hydrostatic interfaces and\n                        predicted gravity of a rotating hydrostatic planet\n                        using the approach of *Wieczorek et al.* (2019).\n\n\n`InertiaTensor_from_shape`  Calculate the inertia tensor given a radial density\n                            profile and shape of each interface.\n\n`InertiaTensor_from_C`      Calculate the inertia tensor given the polar moment\n                            of inertia and the gravitational potential\n                            coefficients.\n\n`moi`                       Calculate the mean, normalized, moment of inertia\n                            up to index n.\n\n\n`ReadRefModel`   Read the reference interior model file.\n\n### Example scripts\n`Moon-Crust`   A script that demonstrates how to calculate the thickenss\n               of the lunar crust using either a constant or variable density\n               crust. The latter can be used to reproduce the results\n               presented in *Wieczorek et al.* (2013).\n\n`Moon-Core`      Calculate the hydrostatic relief of the lunar core accounting\n                 for the non-hydrostatic potential that comes from the\n                 lithosphere.\n\n`Mars-Crust`   A script that demonstrates how to calculate the thickenss\n               of the Martian crust using either a constant or variable\n               density crust. For the variable density crust, the density is\n               assumed to change discontinuously across the dichotomy\n               boundary.\n\n`Mars-Crust-hydrostatic-tests`   Create a crustal thickness map of Mars from\n                                 gravity and topography and compare how results\n                                 change if hydrostatic interfaces are not taken\n                                 into account.\n\n`Mars-Crust-InSight`    Create a crustal thickness map of Mars from gravity\n                        and topography, using the InSight crustal thickness\n                        constraint.\n\n`Mars-Crust-InSight-dichotomy`   Create a crustal thickness map of Mars from\n                                 gravity and topography, using the InSight\n                                 crustal thickness constraint and different\n                                 densities across the dichotomy boundary.\n\n`Mars-fcn`       Compute the free core nutation period of Mars.\n\n`Mars-shape`      Create images related to Mars in *Wieczorek et al.* (2019).\n\n`Mars-j2`        Compute the contribution to the gravitational J2 of Mars from\n                 hydrostatic interfaces beneath the lithosphere.\n\n`Earth-shape`     Compute hydrostatic relief of Earth using PREM.\n\n`Ceres-shape`          Calculate the hydrostatic shape of Ceres.\n\n## How to install and run ctplanet\n\nDownload the ctplanet repository and install using pip\n```bash\n    git clone https://github.com/MarkWieczorek/ctplanet.git\n    pip install .\n```\n\nTo execute a script\n```bash\n    cd examples\n    python Moon-Crust.py\n```\n\nDepending on how your system is set up, it might be necessary to use explicitly `python3` and `pip3` instead of `python` and `pip` in the above commands.\n\n## Reference\n\nWieczorek, M. A., G. A. Neumann, F. Nimmo, W. S. Kiefer, G. J. Taylor,\n    H. J. Melosh, R. J. Phillips, S. C. Solomon, J. C. Andrews-Hanna,\n    S. W. Asmar, A. S. Konopliv, F. G. Lemoine, D. E. Smith, M. M. Watkins,\n    J. G. Williams, M. T. Zuber (2013), The crust of the Moon as seen by GRAIL,\n    *Science*, 339, 671-675, doi:[10.1126/science.1231530](http://doi.org/10.1126/science.1231530).\n\nWieczorek, M. A.,  M. Beuthe, A. Rivoldini, and T. Van Hoolst (2019),\n    Hydrostatic interfaces in bodies with nonhydrostatic lithospheres,\n    *Journal of Geophysical Research: Planets*, 124, doi:[10.1029/2018JE005909](http://doi.org/10.1029/2018JE005909).\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Create a crustal thickness map of a planet",
    "version": "0.2.4",
    "project_urls": {
        "download": "https://github.com/MarkWieczorek/ctplanet/zipball/master",
        "homepage": "https://github.com/MarkWieczorek/ctplanet"
    },
    "split_keywords": [
        "crust",
        "gravity",
        "geophysics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8a8a23cb85afca9447fef2886b7a877ccbb638c30e95b7f5f5a2f08d24e044de",
                "md5": "d6d73c0488b63d5ebc464e7b4a749c09",
                "sha256": "fa7fa26c9bf2af5c18a497ad09c6341c5c5168d10f0bbc1d09e719e8357349ec"
            },
            "downloads": -1,
            "filename": "ctplanet-0.2.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6d73c0488b63d5ebc464e7b4a749c09",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16236,
            "upload_time": "2023-05-19T13:41:35",
            "upload_time_iso_8601": "2023-05-19T13:41:35.724044Z",
            "url": "https://files.pythonhosted.org/packages/8a/8a/23cb85afca9447fef2886b7a877ccbb638c30e95b7f5f5a2f08d24e044de/ctplanet-0.2.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f4b37bfacc0b6d44ff2a68f5974e94c174effe0a895eaada2caa676495be8083",
                "md5": "9bf98ab39697285789729bd51c872ca0",
                "sha256": "88250a86d162df53be1e62a81dbee44a9f46821c1bb739ce8b7fb304dc62103c"
            },
            "downloads": -1,
            "filename": "ctplanet-0.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "9bf98ab39697285789729bd51c872ca0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 22401742,
            "upload_time": "2023-05-19T13:41:39",
            "upload_time_iso_8601": "2023-05-19T13:41:39.371248Z",
            "url": "https://files.pythonhosted.org/packages/f4/b3/7bfacc0b6d44ff2a68f5974e94c174effe0a895eaada2caa676495be8083/ctplanet-0.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-19 13:41:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MarkWieczorek",
    "github_project": "ctplanet",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ctplanet"
}
        
Elapsed time: 0.16754s