Metadata-Version: 2.1
Name: galsampler
Version: 0.1.1
Summary: Galsampler algorithms used for generating synthetic cosmological data
Author-email: Andrew Hearin <ahearin@anl.gov>
License: BSD 3-Clause License
        
        Copyright (c) 2019, LSST Dark Energy Science Collaboration (DESC)
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: home, https://github.com/LSSTDESC/galsampler
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: numba

GalSampler
==========
Tools for generating synthetic cosmological data.


Installation
============
The latest release of galsampler, v0.1.0, can be installed with conda-forge::

      $ conda install lsstdesc-galsampler

To install galsampler into your environment from the source code::

      $ cd /path/to/root/galsampler
      $ pip install .

However you install the code, to use it from a python interpreter::

      >>> import galsampler


Documentation
=============
See https://galsampler.readthedocs.io/en/latest for complete documentation and usage tutorials.

Citation information
====================
The galsampler paper has been published in MNRAS. Citation information for the paper can be found at [this ADS link](https://ui.adsabs.harvard.edu/abs/2020MNRAS.495.5040H/exportcitation), copied below for convenience::

      @ARTICLE{2020MNRAS.495.5040H,
            author = {{Hearin}, Andrew and {Korytov}, Danila and {Kovacs}, Eve and {Benson}, Andrew and {Aung}, Han and {Bradshaw}, Christopher and {Campbell}, Duncan and {LSST Dark Energy Science Collaboration}},
            title = "{Generating synthetic cosmological data with GalSampler}",
            journal = {\mnras},
      keywords = {large-scale structure of Universe, Astrophysics - Cosmology and Nongalactic Astrophysics},
            year = 2020,
            month = jul,
            volume = {495},
            number = {4},
            pages = {5040-5051},
            doi = {10.1093/mnras/staa1495},
      archivePrefix = {arXiv},
            eprint = {1909.07340},
      primaryClass = {astro-ph.CO},
            adsurl = {https://ui.adsabs.harvard.edu/abs/2020MNRAS.495.5040H},
            adsnote = {Provided by the SAO/NASA Astrophysics Data System}
      }

