Code Monkey home page Code Monkey logo

the-wizz's Introduction

the-wizz

INTRODUCTION

the-wizz is a clustering redshift estimating tool designed with ease of use for end users in mind. Simply put, the-wizz allows for clustering redshift estimates for any photometric, unknown sample in a survey by storing all close pairs between the unknown sample and a target, reference sample into a data file. Users then query this data file with their specific selection and correlation scales to produce a clusting redshift. For further details on the method see Schmidt et al. 2013, Menard et al 2013, Rahman et al. 2015(ab), and Morrison et al 2017.

The software is composed of three main parts: a pair_finder, pair_collapser and pdf_maker. pair_finder does the initial heavy lifting of spatial pair finding and stores the indices and compressed distances of all closer pairs around the reference objects in an output Parquet data file. Users then query this data file using pdf_collapser with the indices of their unknown sample, producing an output densities around each reference object. From there pdf_maker bins the data in redshift and computes the final clustering-zs.

CITING the-wizz

Papers utilizing the-wizz should provide a link back to this repository. It is also requested that users cite Morrison et al. 2017. The other cites mentioned at the start of this README are highly recommended as citations as well.

REQUIREMENTS

The library is designed with as little reliance on nonstandard libraries as possible.

astropy (http://www.astropy.org/)
numpy (http://www.numpy.org/)
pandas (https://pandas.pydata.org/)
pyarrow (https://arrow.apache.org/docs/python/install.html)
scipy (http://www.scipy.org/)

INSTALLATION

To install the-wizz, simply clone the repository and run the setup.py script.

git clone https://github.com/morriscb/the-wizz
cd the-wizz
python setup.py install

A pypi install will be coming in the future.

From there you can run the unittests:

python tests/test_pair_maker.py
python tests/test_pair_collapser.py
python tests/test_pdf_maker.py

DOCKER

the-wizz is available as a docker image for easy deployment. This image can be deployed with the following docker command

docker pull morriscb/the-wizz

Tutorials using the docker image of the-wizz will be available soon.

DEMOS

Jupyter notebook demos coming soon.

MAINTAINERS

Current:

the-wizz's People

Contributors

morriscb avatar jlvdb avatar hendrik1008 avatar

Stargazers

Zechang avatar Haojie Xu avatar Song Huang avatar Ignacio Magana avatar Kosmos avatar Josh Speagle avatar Maria Patterson avatar Jes Ford avatar

Watchers

 avatar Song Huang avatar Sam Schmidt avatar M B avatar  avatar

the-wizz's Issues

Store distances in hdf5 file

Store the actual distance of the pairs with pair_maker.py/_compute_bin_values, this should not make any difference in the disk space required. Weights can be determined in pdf_maker, which is handy if I later change my mind about the weight_power.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.