Getting Started

• Install nbodykit
  • Getting nbodykit
  • Installing nbodykit with Anaconda
  • Installing nbodykit with pip
  • nbodykit on NERSC
• A Brief Introduction
  • The lab framework
  • Parallel Computation with MPI
  • Insulating Data from Algorithms
  • Running your Favorite Algorithm
  • Quickstart and Cookbook
  • Extending nbodykit
• Quickstart
• The Cookbook
  • Data Recipes
  • Painting Recipes
  • Algorithm Recipes

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
  • 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
• Iterating through Multiple Tasks
• Analyzing your Results
  • Loading and Saving Results
  • Coordinate Grid
  • Accessing the Data
  • Meta-data
  • Slicing
  • Reindexing
  • Averaging

Help and Reference

• API Reference
  • The IO Library (nbodykit.io)
  • Cosmology (nbodykit.cosmology)
  • Transforming Catalog Data (nbodykit.transform)
  • Data Sources
  • Algorithms (nbodykit.algorithms)
  • Managing Multiple Tasks (TaskManager)
  • Analyzing Results (BinnedStatistic)
  • Internal Nuts and Bolts
• Guide for Developers
• Contact and Support
• Changelog
  • 0.2.7 (unreleased)
  • 0.2.6
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1