| Name | galpak JSON |
| Version |
1.34.0
JSON |
| download |
| home_page | http://galpak3d.univ-lyon1.fr |
| Summary | A tool to extract the intrinsic (i.e. deconvolved) Galaxy Parameters and Kinematics from any 3-Dimensional data. |
| upload_time | 2024-01-19 13:48:20 |
| maintainer | |
| docs_url | None |
| author | Nicolas Bouché |
| requires_python | >=3.5 |
| license | GPL |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
WHAT IS IT
==========
GalPaK 3D is a tool to extract Galaxy Parameters and Kinematics from 3-Dimensional data,
using reverse deconvolution with Bayesian analysis Markov chain Monte Carlo. (random walk)
See the documentation for more details about the API on the [web site](http://galpak3d.univ-lyon1.fr/).
INSTALL
=======
pip install galpak
PYTHON DEPENDENCIES
-------------------
The galpak module has been developed for Python 2.7 and
has been tested with Python 3.5 & 3.7
The following are mandatory python modules that galpak depends upon :
numpy>=1.14
scipy
astropy>=2.0
matplotlib>=2.0
The following optional python modules improve galpak performances :
pyfftw : https://pypi.python.org/pypi/pyFFTW
bottleneck : https://pypi.python.org/pypi/Bottleneck/
The following optional python modules improve galpak functionalities :
corner : https://pypi.python.org/pypi/corner
emcee : https://pypi.org/project/emcee/
mpdaf : http://mpdaf.readthedocs.io/en/latest/
MPDAF PACKAGES
--------------
_Optional._
GalPaK provides a `MUSELineSpreadFunction` class that depends on `mpdaf.MUSE.LSF`.
Follow [MPDAF install instructions](https://mpdaf.readthedocs.io/en/latest/installation.html).
GalPaK also accepts MPDAF's Cubes as input.
I FOUND A BUG!
==============
THERE WILL BE BUGS.
If you have found a bug in GalPaK3D please report it on the
galpak [forum/mailing list](https://groups.google.com/group/galpak3d).
Can _you_ reproduce it ? Provide the code and input cube(s).
You cannot reproduce it ? just describe what you're doing when it happens.
Also, we encourage everyone to give us feedback and participate in discussions.
We can use the [galpak3d](https://mail.python.org/mailman3/lists/galpak3d.python.org/) mailing list as well.
Email the above at <nicolas.bouche@univ-lyon1.fr> and/or add them as
test-case in the test suite.
HOW TO TEST
===========
untar and do
```
python -m pytest
```
HOW TO DOCUMENT
===============
Install sphinx :
```
$ sudo apt-get install python-sphinx
```
or
```
$ pip install --user sphinx
```
Make your changes into the `doc/source` files.
Once its done, you can either :
$ cd doc
$ make html
or :
$ doit doc
FITS Sanitizer
==============
`python fits_sanitizer.py [-h] [--prefix PREFIX] FILE [FILE ...]`
Sanitize specified FITS files. By default, this will overwrite the FITS files.
To create another file(s), you can specify a prefix using the --prefix option.
What this actually does :
- Lowercase 'DEG' unit
- that's all ! (it did some other things in the past)
positional arguments:
FILE A FITS file to sanitize
optional arguments:
-h, --help show this help message and exit
--prefix PREFIX A prefix to prepend to the filename(s), to create new files
Tip : you can sanitize a whole folder using the `*` wildcard : `python fits_sanitizer.py /myfits/*.fits`
Note that this will be superseded by the HyperspectralCube class `sanitize` method.
ACRONYMS
========
Real men never define acronyms. They understand them genetically.
FFT Fast Fourier Transform
FITS Flexible Image Transport System
FWHM Full Width at Half Maximum
HDU Header Data Unit
LSF Line Spread Function
Wavelength spread due to the dispersion of light in the atmosphere
MCMC Markov Chain Monte Carlo
MPDAF MUSE Python Data Analysis Framework
MUSE Multi Unit Spectroscopic Explorer
NFM Narrow Field Mode
PA Position Angle
PC ParseC
PSF Point Spread Function
Spatial spread caused by the atmosphere
SNR Signal Noise Ratio
The relative intensity of the signal from the noise
Should be > 1, or the data is useless
WFM Wide Field Mode
WSC World Coordinates System
BLACKBOARD
==========
It would be smart to use a MCMC module :
- [pymc3](https://docs.pymc.io/).
Raw data
{
"_id": null,
"home_page": "http://galpak3d.univ-lyon1.fr",
"name": "galpak",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "",
"author": "Nicolas Bouch\u00e9",
"author_email": "nicolas.bouche@univ-lyon1.fr",
"download_url": "https://files.pythonhosted.org/packages/a2/4e/f2fdf7c6055190d0eb4dd23655dd181f130fabc8c9cad47d89bf498a50a1/galpak-1.34.0.tar.gz",
"platform": null,
"description": "WHAT IS IT\n==========\n\nGalPaK 3D is a tool to extract Galaxy Parameters and Kinematics from 3-Dimensional data,\nusing reverse deconvolution with Bayesian analysis Markov chain Monte Carlo. (random walk)\n\nSee the documentation for more details about the API on the [web site](http://galpak3d.univ-lyon1.fr/).\n\n\nINSTALL\n=======\n\npip install galpak\n\nPYTHON DEPENDENCIES\n-------------------\n\n\nThe galpak module has been developed for Python 2.7 and\n has been tested with Python 3.5 & 3.7\n\nThe following are mandatory python modules that galpak depends upon :\n\n numpy>=1.14\n scipy\n astropy>=2.0\n matplotlib>=2.0\n\nThe following optional python modules improve galpak performances :\n\n pyfftw : https://pypi.python.org/pypi/pyFFTW\n bottleneck : https://pypi.python.org/pypi/Bottleneck/\n\nThe following optional python modules improve galpak functionalities :\n\n corner : https://pypi.python.org/pypi/corner\n emcee : https://pypi.org/project/emcee/\n mpdaf : http://mpdaf.readthedocs.io/en/latest/\n\n\nMPDAF PACKAGES\n--------------\n\n_Optional._\n\nGalPaK provides a `MUSELineSpreadFunction` class that depends on `mpdaf.MUSE.LSF`.\nFollow [MPDAF install instructions](https://mpdaf.readthedocs.io/en/latest/installation.html).\n\nGalPaK also accepts MPDAF's Cubes as input.\n\n\n\nI FOUND A BUG!\n==============\n\nTHERE WILL BE BUGS. \nIf you have found a bug in GalPaK3D please report it on the\ngalpak [forum/mailing list](https://groups.google.com/group/galpak3d).\nCan _you_ reproduce it ? Provide the code and input cube(s).\nYou cannot reproduce it ? just describe what you're doing when it happens.\n\nAlso, we encourage everyone to give us feedback and participate in discussions.\nWe can use the [galpak3d](https://mail.python.org/mailman3/lists/galpak3d.python.org/) mailing list as well.\n\nEmail the above at <nicolas.bouche@univ-lyon1.fr> and/or add them as\ntest-case in the test suite.\n\n\n\n\nHOW TO TEST\n===========\n\nuntar and do\n```\npython -m pytest \n```\n\n\nHOW TO DOCUMENT\n===============\n\nInstall sphinx :\n```\n$ sudo apt-get install python-sphinx\n```\nor\n```\n$ pip install --user sphinx\n```\n\nMake your changes into the `doc/source` files.\n\nOnce its done, you can either :\n\n $ cd doc\n $ make html\n\nor :\n\n $ doit doc\n\n\nFITS Sanitizer\n==============\n\n`python fits_sanitizer.py [-h] [--prefix PREFIX] FILE [FILE ...]`\n\nSanitize specified FITS files. By default, this will overwrite the FITS files.\nTo create another file(s), you can specify a prefix using the --prefix option.\n\nWhat this actually does :\n - Lowercase 'DEG' unit\n - that's all ! (it did some other things in the past)\n\npositional arguments:\n FILE A FITS file to sanitize\n\noptional arguments:\n -h, --help show this help message and exit\n --prefix PREFIX A prefix to prepend to the filename(s), to create new files\n\n\nTip : you can sanitize a whole folder using the `*` wildcard : `python fits_sanitizer.py /myfits/*.fits`\n\nNote that this will be superseded by the HyperspectralCube class `sanitize` method.\n\n\nACRONYMS\n========\n\nReal men never define acronyms. They understand them genetically.\n\nFFT Fast Fourier Transform\nFITS Flexible Image Transport System\nFWHM Full Width at Half Maximum\nHDU Header Data Unit\nLSF Line Spread Function\n Wavelength spread due to the dispersion of light in the atmosphere\nMCMC Markov Chain Monte Carlo\nMPDAF MUSE Python Data Analysis Framework\nMUSE Multi Unit Spectroscopic Explorer\nNFM Narrow Field Mode\nPA Position Angle\nPC ParseC\nPSF Point Spread Function\n Spatial spread caused by the atmosphere\nSNR Signal Noise Ratio\n The relative intensity of the signal from the noise\n Should be > 1, or the data is useless\nWFM Wide Field Mode\nWSC World Coordinates System\n\n\nBLACKBOARD\n==========\n\nIt would be smart to use a MCMC module :\n - [pymc3](https://docs.pymc.io/).\n\n\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "A tool to extract the intrinsic (i.e. deconvolved) Galaxy Parameters and Kinematics from any 3-Dimensional data.",
"version": "1.34.0",
"project_urls": {
"Homepage": "http://galpak3d.univ-lyon1.fr"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6e331d39b2f23529ead0bdbff2c2679b328d48a47d73c3c135a2d39132bce80",
"md5": "2845db0b5b68065a5483198b942d9fba",
"sha256": "c9af914632ca605e330bb9ec647ad25eb917d296c3685d29df4f83334ff9172e"
},
"downloads": -1,
"filename": "galpak-1.34.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2845db0b5b68065a5483198b942d9fba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 90167,
"upload_time": "2024-01-19T13:48:17",
"upload_time_iso_8601": "2024-01-19T13:48:17.584073Z",
"url": "https://files.pythonhosted.org/packages/d6/e3/31d39b2f23529ead0bdbff2c2679b328d48a47d73c3c135a2d39132bce80/galpak-1.34.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a24ef2fdf7c6055190d0eb4dd23655dd181f130fabc8c9cad47d89bf498a50a1",
"md5": "e72a3d54d8faf879706c5fe1231ffc1d",
"sha256": "b6364f6e39b5dfe506049b86a78e6afda539118a67dc50b855ecdb4dbb4e9db2"
},
"downloads": -1,
"filename": "galpak-1.34.0.tar.gz",
"has_sig": false,
"md5_digest": "e72a3d54d8faf879706c5fe1231ffc1d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 12385682,
"upload_time": "2024-01-19T13:48:20",
"upload_time_iso_8601": "2024-01-19T13:48:20.355278Z",
"url": "https://files.pythonhosted.org/packages/a2/4e/f2fdf7c6055190d0eb4dd23655dd181f130fabc8c9cad47d89bf498a50a1/galpak-1.34.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-19 13:48:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "galpak"
}
