Skip to content
/ adapy Public
forked from vilhelmp/adapy

Astronomical data analysis and visualization scripts.

Notifications You must be signed in to change notification settings

tk575/adapy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ADAPY
=====
My collection of scripts to handle my radio astronomical data and other various related tasks.
Mostly for my own benefit, having a backup hosted elsewhere.

NB : Some stuff is potentially broken...

Needs:
- Pyfits
- Scipy (Numpy)
- Matplotlib

Optional:
- MPFIT (for least-square fitting) (Line Fitting)
- lmfit (for uvmodelfit) (deprecated, now has its own bug-full MCMC code...)
- Astropy (moving over to use this module instead, which already has pWCS and pyFITS)
Recommended:
- Python 2.7

Install: 
	git get/download it to a folder, 
	modify the systems PYTHONPATH var-
	iable to include the "adapy" dir-
	ectory (not where the folder "bin" 
	resides). 

	For cli access to "splatsearch" and 
	"ads-search" add "bin" directory to 
	systems PATH variable.
	
	I don't know yet how to work with the setup.py stuff.
	Will fix that at some point.

Author: Magnus Persson (magnusp@vilhelm.nu)

Only tested on my machine, running Ubuntu Linux and with my data (APEX, SMA, ALMA, PdBI, IRAM-30M). 

Copyright and Licensing: BSD

----------------------------------------------------------------------
## WHAT TO PUT IN THE README FILE
README
In addition to the docstrings in your code and the resulting HTML documentation, you should create a README.txt file in the top level of your directory structure. Put it under version control. Your README.txt should contain the following:

How to run the program(s), if your package contains scripts

Pointer to full documentation
Some people like to break a few of these out into separate files (INSTALL, AUTHORS, ANNOUNCE...), but personally I prefer to keep it simple.

If you already have this information in your docstrings or somewhere else, by all means, don’t repeat yourself: either use Sphinx, which can also produce plain (reStructured) text, or whip up a script to pull out the information and write your README.txt for you. You can extract the docstring from any module, class, or function with, e.g., mymodule.__doc__. Here’s how to make Sphinx output plain (reStructured) text to the text/ directory:

$ sphinx-build -b text . text/
Documentation Resources
PEP 257, Docstring Conventions: http://www.python.org/dev/peps/pep-0257/
reStructuredText markup: http://docutils.sourceforge.net/rst.html
Sphinx, Python Documentation Generator: http://sphinx.pocoo.org/

About

Astronomical data analysis and visualization scripts.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%