CosmicProfiles

CosmicProfiles: A Python package for radial profiling of finitely sampled dark matter halos and galaxies - Published in JOSS (2023)

https://github.com/tibordome/cosmic_profiles

Keywords

Scientific Fields

Repository

Implements 3D point cloud algorithms for estimation and fitting of shape and density profiles

README.rst

|Logo|

CosmicProfiles is a Cython package for Point Cloud Profiling

|Build Status| |Platforms| |Zenodo| |JOSS|

The CosmicProfiles project
****************************

This repository provides shape and density profile analysis tools for cosmological simulations (and beyond). Its features include

- overall halo shape determination, i.e. major, intermediate, minor axis vectors and shape quantities such as intermediate-to-major axis ratio or sphericity
- halo shape profile determination

  - iterative shell-based shape profile determination algorithm for high-resolution halos
  - iterative ellipsoid-based shape profile determination algorithm for lower-resolution halos
  - user can choose between reduced shape tensor and non-reduced shape tensor
- supports

  - 'direct' datasets (i.e. index catalogue provided by user) and
  - FoF / SUBFIND halo catalogues
  - Gadget-style I, II and HDF5 snapshot files
  
    - all functionalities available for dark matter halos, gas particle halos and star particle halos
    - in addition, allows for velocity dispersion tensor eigenaxes determination
- halo density profile estimation using direct binning and kernel-based approaches

  - user can choose between direct binning into spherical shells and
  - direct binning into ellipsoidal shells
- density profile fitting assuming either `NFW `_, `Hernquist 1990 `_, `Einasto `_ or `alpha-beta-gamma `_ profile model

  - concentration-mass relationship of halos easy to calculate
- mock halo generator: ellipsoidal or spherical, compatible with the 4 density profile models
- easy to interface with `pynbody` to work with halos identified in a cosmological simulation (see example scripts)
- easy to interface with `nbodykit` to harness large-scale structure capabilities (see example scripts)
- various profile plotting and 3D point cloud plotting tools
- efficient caching capabilities to accelerate look-ups

Documentation
****************************

|Documentation Status|

The documentation for CosmicProfiles is hosted on `Read the Docs
`__.

Installation and Dependencies
******************************

|PyPI| |Name| |Downloads| |Version|

The easiest way to get CosmicProfiles is to install it with conda using the conda-forge channel::

    conda install cosmic_profiles --channel conda-forge
    
Alternatively, you can use pip::

   pip install cosmic-profiles

See the `installation
instructions `_ in the
`documentation `__ for more information.

License
****************************

|License|

Copyright 2020-2023 Tibor Dome.

CosmicProfiles is free software made available under the MIT License.

Contributions are welcome. Please raise an issue or open a PR.


.. |PyPI| image:: https://badge.fury.io/py/cosmic_profiles.svg
   :target: https://badge.fury.io/py/cosmic_profiles
.. |Logo| image:: https://cosmic-profiles.readthedocs.io/en/latest/_images/CProfiles.png
   :target: https://github.com/tibordome/cosmic_profiles
   :width: 400
.. |Documentation Status| image:: https://readthedocs.org/projects/cosmic-profiles/badge/?version=latest
   :target: https://cosmic-profiles.readthedocs.io/en/latest/?badge=latest
.. |Zenodo| image:: https://zenodo.org/badge/475501515.svg
   :target: https://zenodo.org/badge/latestdoi/475501515
.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.05008/status.svg
   :target: https://doi.org/10.21105/joss.05008
.. |Build status| image:: https://app.travis-ci.com/tibordome/cosmic_profiles.svg?branch=master
   :target: https://app.travis-ci.com/tibordome/cosmic_profiles
.. |Name| image:: https://img.shields.io/badge/recipe-cosmic_profiles-green.svg
   :target: https://anaconda.org/conda-forge/cosmic_profiles
.. |Downloads| image:: https://img.shields.io/conda/dn/conda-forge/cosmic_profiles.svg
   :target: https://anaconda.org/conda-forge/cosmic_profiles
.. |Version| image:: https://img.shields.io/conda/vn/conda-forge/cosmic_profiles.svg
   :target: https://anaconda.org/conda-forge/cosmic_profiles
.. |Platforms| image:: https://img.shields.io/conda/pn/conda-forge/cosmic_profiles.svg
   :target: https://anaconda.org/conda-forge/cosmic_profiles
.. |License| image:: https://anaconda.org/conda-forge/cosmic_profiles/badges/license.svg
   :target: https://anaconda.org/conda-forge/cosmic_profiles

Owner

JOSS Publication

CosmicProfiles: A Python package for radial profiling of finitely sampled dark matter halos and galaxies

Published

May 16, 2023

DOI

10.21105/joss.05008

Volume 8, Issue 85, Page 5008

Authors

Tibor Dome
PhD Student, University of Cambridge, Institute of Astronomy, Madingley Rd, Cambridge CB3 0HA, United Kingdom

Editor

Axel Donath

Tags

astronomy cosmology simulations point clouds

View PDF Review Thread Software Archive

GitHub Events

Committers

Last synced: 5 months ago

Issues and Pull Requests

Last synced: 4 months ago

Packages