****************
halotools
****************

Welcome to the halotools documentation. Halotools is a python package 
designed to study large-scale structure, cosmology, and galaxy evolution 
using N-body simulations and halo models. The code is publicly available 
at https://github.com/halotools.

The package is still under rapid development, with its API being restructured 
frequently. In short, it is still not "stable." In particular, 
if you download the code and write 
scripts based on the current API, your scripts will likely not 
correctly interface with future versions of the code.

Presently, only the basic API is documented. Once more of 
the core functionality is in place, step-by-step examples will be included, 
as will iPython notebook tutorials. 

Contributions to the halotools package are warmly welcomed! 
If you are interested in collaborating, and/or would like to know more 
about the intended scope of the project, please contact Andrew Hearin 
at andrew-dot-hearin-at-yale-dot-edu.


Reference/API
=============
.. automodapi:: halotools.hod_designer
.. automodapi:: halotools.make_mocks
.. automodapi:: halotools.halo_occupation
.. automodapi:: halotools.occupation_helpers
.. automodapi:: halotools.mock_factory
.. automodapi:: halotools.hod_factory
.. automodapi:: halotools.hod_components
.. automodapi:: halotools.jeans
.. automodapi:: halotools.defaults
.. automodapi:: halotools.read_nbody