NFW


NameNFW JSON
Version 0.3.1 PyPI version JSON
download
home_pagehttps://github.com/joergdietrich/NFW
SummaryPython routines for computing Navarro-Frenk-White halo properties
upload_time2022-12-29 22:53:42
maintainer
docs_urlNone
authorJörg Dietrich
requires_python
licenseMIT
keywords nfw halo astrophysics astronomy galaxy-clusters galaxies navarro-frenk-white
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            Navarro-Frenk-White (NFW) Halo Class
====================================

|Build Status| |Coverage Status| |DOI|

This class implements the NFW (Navarro, Julio F. Frenk, Carlos S. White,
Simon D. M., "A Universal Density Profile from Hierarchical Clustering",
The Astrophysical Journal vol. 490, pp. 493-508, 1997) halo profile. It
allows easy computation of halo quantities such as mass at and radius of
specified overdensities. Overdensities can be specified either with
respect to the critical or mean density of the Universe.

Class instances can be created at different overdensities. As such
the class allows for easy conversion between masses and concentration
parameters between different mass definitions.

Surface mass density and differential surface mass density methods are
available for weak lensing applications.

Installation
------------

The easiest way to install the NFW module is to use pip::
  
  $ pip install NFW


Dependencies
------------

This implementation of the NFW halo properties depends on

-  numpy >= 1.9
-  scipy >= 0.16
-  astropy >= 2.0

Older versions may work but are untested. In particular astropy > 1.0 is
known to work but the unit tests will fail because astropy-2.0 updated
physical constants from CODATA 2010 to CODATA 2014.

Author
------

Jörg Dietrich astro@joergdietrich.com

Contributing
------------

Development takes place on GitHub_. Please report any bugs as an issue in the
GitHub issue tracker.

License
-------

NFW is released under an MIT license. See LICENCE.txt


.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/joergdietrich/NFW/main.yml
   :target: https://github.com/joergdietrich/NFW/actions
.. |Coverage Status| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/joergdietrich/fdfe01f268aa013bfbc3f426b2fce781/raw/covbadge.json
.. |DOI| image:: https://zenodo.org/badge/doi/10.5281/zenodo.50664.svg
   :target: http://dx.doi.org/10.5281/zenodo.50664
.. _GitHub: https://github.com/joergdietrich/NFW

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/joergdietrich/NFW",
    "name": "NFW",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "nfw halo astrophysics astronomy galaxy-clusters galaxies navarro-frenk-white",
    "author": "J\u00f6rg Dietrich",
    "author_email": "astro@joergdietrich.com",
    "download_url": "https://files.pythonhosted.org/packages/b2/ca/7e3eb2eba9e114df2b74e9520c18db75a6cf74bd7222eb628482f1160c06/NFW-0.3.1.tar.gz",
    "platform": null,
    "description": "Navarro-Frenk-White (NFW) Halo Class\n====================================\n\n|Build Status| |Coverage Status| |DOI|\n\nThis class implements the NFW (Navarro, Julio F. Frenk, Carlos S. White,\nSimon D. M., \"A Universal Density Profile from Hierarchical Clustering\",\nThe Astrophysical Journal vol. 490, pp. 493-508, 1997) halo profile. It\nallows easy computation of halo quantities such as mass at and radius of\nspecified overdensities. Overdensities can be specified either with\nrespect to the critical or mean density of the Universe.\n\nClass instances can be created at different overdensities. As such\nthe class allows for easy conversion between masses and concentration\nparameters between different mass definitions.\n\nSurface mass density and differential surface mass density methods are\navailable for weak lensing applications.\n\nInstallation\n------------\n\nThe easiest way to install the NFW module is to use pip::\n  \n  $ pip install NFW\n\n\nDependencies\n------------\n\nThis implementation of the NFW halo properties depends on\n\n-  numpy >= 1.9\n-  scipy >= 0.16\n-  astropy >= 2.0\n\nOlder versions may work but are untested. In particular astropy > 1.0 is\nknown to work but the unit tests will fail because astropy-2.0 updated\nphysical constants from CODATA 2010 to CODATA 2014.\n\nAuthor\n------\n\nJ\u00f6rg Dietrich astro@joergdietrich.com\n\nContributing\n------------\n\nDevelopment takes place on GitHub_. Please report any bugs as an issue in the\nGitHub issue tracker.\n\nLicense\n-------\n\nNFW is released under an MIT license. See LICENCE.txt\n\n\n.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/joergdietrich/NFW/main.yml\n   :target: https://github.com/joergdietrich/NFW/actions\n.. |Coverage Status| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/joergdietrich/fdfe01f268aa013bfbc3f426b2fce781/raw/covbadge.json\n.. |DOI| image:: https://zenodo.org/badge/doi/10.5281/zenodo.50664.svg\n   :target: http://dx.doi.org/10.5281/zenodo.50664\n.. _GitHub: https://github.com/joergdietrich/NFW\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python routines for computing Navarro-Frenk-White halo properties",
    "version": "0.3.1",
    "split_keywords": [
        "nfw",
        "halo",
        "astrophysics",
        "astronomy",
        "galaxy-clusters",
        "galaxies",
        "navarro-frenk-white"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "772cdbd95925316a9d32cd4695c45399",
                "sha256": "b58c646b3307927ed4d6ee13f456bc6a5226fff532c54b89a54e3bc056ce52ee"
            },
            "downloads": -1,
            "filename": "NFW-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "772cdbd95925316a9d32cd4695c45399",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8367,
            "upload_time": "2022-12-29T22:53:40",
            "upload_time_iso_8601": "2022-12-29T22:53:40.738405Z",
            "url": "https://files.pythonhosted.org/packages/6c/f0/c6770d960fb0d5c9de2feff2e975744fe8efbd38bc917e18ac2fceb40f39/NFW-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "a71166ae2537dd053c08ddc08d874a0b",
                "sha256": "3742761fdbb67151856d77cf005d34dce5e7e4520f75470c7fadf07cef0987d2"
            },
            "downloads": -1,
            "filename": "NFW-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a71166ae2537dd053c08ddc08d874a0b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8930,
            "upload_time": "2022-12-29T22:53:42",
            "upload_time_iso_8601": "2022-12-29T22:53:42.391740Z",
            "url": "https://files.pythonhosted.org/packages/b2/ca/7e3eb2eba9e114df2b74e9520c18db75a6cf74bd7222eb628482f1160c06/NFW-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-29 22:53:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "joergdietrich",
    "github_project": "NFW",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "nfw"
}
        
Elapsed time: 0.05224s