Giter Club home page Giter Club logo

deconv3d's Introduction

WHAT IS IT

This is a work in progress.

This is an implementation of a MCMC for estimation and non-parametric deconvolution of galactic kinematics from hyperspectral data cubes.

It is a python 2.7 module designed to be flexible, reliable and fast. It has not been tested under python 3.x, but feel free to make it compatible !

HOW TO INSTALL

Using pip

(still not available)

Install deconv3d system-wide,

$ sudo pip install deconv3d

or just for you :

$ pip install --user deconv3d

Running one of the above commands will download and install the module on your system, as deconv3d is referenced on the official [python package index] (https://pypi.python.org).

Manually

(still not available)

Running python setup.py install should do the trick.

Mandatory Dependencies

Optional Dependencies

DEBIAN PACKAGES

Most of the usual packages can be installed system-wise from repositories.

python2.7 python-numpy python-astropy python-matplotlib

You can also install them via pip, it's your choice.

MPDAF PACKAGES

Optional.

deconv3d provides a MUSELineSpreadFunction class that depends on mpdaf.MUSE.LSF.

Follow [MPDAF install instructions] (http://urania1.univ-lyon1.fr/mpdaf/chrome/site/DocCoreLib/installation.html).

deconv3d also accepts MPDAF's Cubes as input.

HOW TO TEST

Simply run nosetests -v --nocapture --nologcapture from project's root :

  • -v is verbose
  • --nocapture means print statements will print
  • --nologcapture means logging statements will print

These options are not mandatory for the tests to pass, but they are useful.

If you don't have nose, you can either

$ apt-get install python-nose

or

$ pip install --user nose

HOW TO DOCUMENT

Install sphinx :

$ apt-get install python-sphinx

Make your changes into the doc/source files.

Once its done, go to doc directory, run make html.

HOW TO CONTRIBUTE

Get the sources.

Create a virtualenv with python 2.7 :

$ virtualenv venv2.7 -p /usr/bin/python2.7

Activate that virtualenv :

$ source venv2.7/bin/activate

Install dependencies :

$ pip install -r requirements.txt

You're ready to run the test-suite !

ACRONYMS

Real geniuses never define acronyms. They understand them genetically.

Acronym Meaning
EAFP Easier to Ask for Forgiveness than Permission
FFT Fast Fourier Transform
FITS Flexible Image Transport System
FWHM Full Width at Half Maximum
HDU Header Data Unit
LBYL Look Before You Leap
LSF Line Spread Function
MCMC Markov Chain Monte Carlo
MH Metropolis-Hastings
MPDAF MUSE Python Data Analysis Framework
MUSE Multi Unit Spectroscopic Explorer
NFM Narrow Field Mode
PA Position Angle
PC ParseC
PSF Point Spread Function
SNR Signal to Noise Ratio
WCS World Coordinates System
WFM Wide Field Mode

deconv3d's People

Contributors

goutte avatar

Watchers

James Cloos avatar

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.