nbodykit 0.3.13
  • Cookbook
  • API
  • Site

      Getting Started

      • Install nbodykit
        • Getting nbodykit
        • Installing nbodykit with Anaconda
        • Installing nbodykit with pip
        • nbodykit on NERSC
      • A Brief Introduction
        • The lab framework
        • Setting up logging
        • Parallel computation with MPI
        • Cosmology and units
        • Interacting with data in nbodykit
        • A component-based approach
        • Catalogs and dask
        • Running your favorite algorithm
        • The Cookbook
        • Questions, feedback, and contributions
      • Cosmological Calculations
        • The Cosmology class
        • Theoretical Power Spectra
        • Correlation functions
      • The Cookbook
        • Angular Pair Counting
        • The Multipoles of the BOSS DR12 Dataset
        • The Power Spectrum of Survey Data
        • The Power Spectrum of Data in a Simulation Box
        • Halo Occupation Distribution (HOD) Mocks
        • The Effects of Interlaced Painting
        • Mesh Interpolation Windows
        • Log-normal Mocks
        • Painting a Catalog to a Mesh
        • The Projected Power Spectrum of Data in a Simulation Box
        • Data Recipes
        • Painting Recipes
        • Algorithm Recipes
        • Contributing

      Discrete Data Catalogs

      • Overview
        • What is a CatalogSource?
        • Use Cases
        • Requirements
        • Default Columns
        • Storing Meta-data
        • API
      • Reading Catalogs from Disk
        • Supported Data Formats
        • Reading Multiple Data Files at Once
        • Reading a Custom Data Format
      • On Demand IO via dask.array
        • What is a dask array?
        • By Example
        • Caching with Dask
        • Examining Larger-than-Memory Data
      • Common Data Operations
        • Accessing Data Columns
        • Computing Data Columns
        • Adding New Columns
        • Overwriting Columns
        • Adding Redshift-space Distortions
        • Selecting a Subset
        • Selecting a Subset of Columns from a CatalogSource
        • The nbodykit.transform module
      • Generating Catalogs of Mock Data
        • Randomly Distributed Objects
        • Log-normal Mocks
        • Halo Occupation Distribution Mocks

      Data on a Mesh

      • Overview
        • What is a MeshSource?
        • Use Cases
        • Painting the Mesh
        • Fields: RealField and ComplexField
        • Storing Meta-data
        • API
      • Creating a Mesh
        • Converting a CatalogSource to a Mesh
        • Gaussian Realizations
        • From In-memory Data
      • Painting Catalogs to a Mesh
        • The Painted Field
        • Operations
        • Shot-noise
        • Default Behavior
        • More Examples
      • Common Mesh Operations
        • Previewing the Mesh
        • Saving and Loading a Mesh
        • Applying Functions to the Mesh
        • Resampling a Mesh

      Getting Results

      • Available Algorithms
        • Power Spectrum Algorithms
        • Correlation Function Algorithms
        • Grouping Methods
        • Miscellaneous
      • Parallel Computation
        • Running nbodykit in parallel
        • A Primer on MPI Communication
        • Data-based parallelism
        • Task-based parallelism
      • Analyzing your Results
        • Loading and Saving Results
        • Coordinate Grid
        • Accessing the Data
        • Meta-data
        • Slicing
        • Reindexing
        • Averaging
      • Saving your Results

      Help and Reference

      • API Reference
        • The nbodykit lab
        • Cosmology (nbodykit.cosmology)
        • Transforming Catalog Data (nbodykit.transform)
        • Data Sources
        • Algorithms (nbodykit.algorithms)
        • Managing Multiple Tasks (TaskManager)
        • Analyzing Results (BinnedStatistic)
        • The IO Library (nbodykit.io)
        • Internal Nuts and Bolts
      • Contact and Support
      • Contributing Guidelines
        • Requesting a Feature
        • Bug Reporting
        • Setting up for Local Development
        • Opening a Pull Request
        • Contributing to the Cookbook
      • Changelog
        • 0.3.14 (Unreleased)
        • 0.3.13 (2019-08-01)
        • 0.3.12 (2019-07-06)
        • 0.3.11 (2019-04-28)
        • 0.3.10 (2019-02-07)
        • 0.3.9 (2019-01-07)
        • 0.3.8 (2018-12-29)
        • 0.3.7 (2018-10-17)
        • 0.3.6 (2018-09-26)
        • 0.3.5 (2018-08-23)
        • 0.3.4 (2018-06-29)
        • 0.3.3 (2018-05-30)
        • 0.3.2 (2018-05-14)
        • 0.3.1 (2018-04-10)
        • 0.3.0 (2017-12-18)
        • 0.2.9 (2017-11-15)
        • 0.2.8 (2017-10-06)
        • 0.2.7 (2017-09-25)
        • 0.2.6 (2017-08-29)
        • 0.2.5 (2017-08-25)
        • 0.2.4 (2017-06-18)
        • 0.2.3 (2017-05-19)
        • 0.2.2 (2017-04-27)
        • 0.2.1 (2017-04-26)
  • Page
      • Available Algorithms
        • Power Spectrum Algorithms
        • Correlation Function Algorithms
        • Grouping Methods
        • Miscellaneous
  • Source

Available Algorithms¶

nbodykit includes several state-of-the-art implementations of canonical algorithms in the field of large-scale structure. It includes functionality for computing a wide variety of clustering statistics on data, as well as algorithms for finding groups of objects.

We describe these algorithms in detail below, and users can also find further examples in The Cookbook section of the documentation.

Power Spectrum Algorithms¶

  • Simulation Box Power Spectrum/Multipoles (FFTPower)
  • Power Spectrum Multipoles of Survey Data (ConvolvedFFTPower)
  • Power Spectrum of a Projected Field (ProjectedFFTPower)

Correlation Function Algorithms¶

  • Correlation Functions via FFT (FFTCorr)
  • Pair Counts for Data in a Simulation Box (SimulationBoxPairCount)
  • Pair Counts for Survey Data (SurveyDataPairCount)
  • Correlation Function for Data in a Simulation Box (SimulationBox2PCF)
  • Correlation Function for Survey Data (SurveyData2PCF)
  • 3-pt Correlation Function for Data in a Simulation Box (SimulationBox3PCF)
  • 3-pt Correlation Function for Survey Data (SurveyData3PCF)

Grouping Methods¶

  • Friends-of-Friends Group Finder (FOF)
  • Cylindrical Groups (CylindricalGroups)
  • Fiber Assignment and Collisions (FiberCollisions)

Miscellaneous¶

  • Density Estimation (KDDensity)
  • Computing the \(n(z)\) of Data (RedshiftHistogram)

Back to top

© Copyright 2015-2017, Nick Hand, Yu Feng.
Created using Sphinx 2.1.2.