Metadata-Version: 2.1
Name: lens_population_sampler
Version: 0.1.0
Summary: Python package to sample from a velocity dispersion function of ellictical galaxies in the local universe
Home-page: https://github.com/vikramb1/lens_population_sampler
Author: Vikram Bhamre
Author-email: bhamrev@stpaulsschool.org.uk
License: MIT license
Keywords: vdf_sampler
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
License-File: LICENSE
License-File: AUTHORS.rst

===========
VDF sampler
===========


.. image:: https://img.shields.io/pypi/v/vdf_sampler.svg
        :target: https://pypi.python.org/pypi/vdf_sampler

.. image:: https://img.shields.io/travis/vikramb1/vdf_sampler.svg
        :target: https://travis-ci.com/vikramb1/vdf_sampler

.. image:: https://readthedocs.org/projects/vdf-sampler/badge/?version=latest
        :target: https://vdf-sampler.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status




Python package to sample from a velocity dispersion function of ellictical galaxies in the local universe


* Free software: MIT license
* Documentation: https://vdf-sampler.readthedocs.io.

Example
-------

.. code-block:: python

        # import package
        import vdf_sampler

        # produces 1000 samples with velocity dispersion between 100 and 200. The approximation uses 500 bins.
        samples = sample_vdf(100, 200, resolution = 500, size = 1000)
        print(samples)

Credits
-------

This package uses the function derived from analysing the velocity dispersions of ellictical galaxies using the Sloan Digital Sky Survey in (`Choi, Park, & Vogeley (2007)  <https://ui.adsabs.harvard.edu/abs/2007ApJ...658..884C/abstract>`_).  

This package uses a modified class from hierArc_, created by `Simon Birrer`_.

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _hierArc: https://github.com/sibirrer/hierArc
.. _`Simon Birrer`: https://github.com/sibirrer
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

=======
History
=======

0.1.0 (2022-08-22)
------------------

* First release on PyPI.
