| Name | epspy JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Extragalactic Point Sources |
| upload_time | 2024-06-26 03:10:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Shikhar Mittal Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
extragalactic
foregrounds
point sources
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Overview
--------
:Name: Extragalactic Point Sources
:Author: `Shikhar Mittal <https://sites.google.com/view/shikharmittal/home>`_
:Paper: `Mittal et al. (2024) <https://arxiv.org/abs/2406.17031>`_
Why do you need this code?
--------------------------
Use this code to generate the foregrounds due to extragalactic point sources.
A cosmological global 21-cm signal hides under foregrounds due to galactic and extragalactic emissions. These foregrounds can easily be 4 to 5 orders of magnitude higher than the signal of interest. For a reliable inference it is important to accurately model these foregrounds. While we have a reasonable understanding of galactic emission (typically fit as log-log polynomial), we do not understand the extragalactic contributions. This package models the foregrounds due to extragalactic radio sources.
Read more about it in the paper `Mittal et al (2024) <https://arxiv.org/abs/2406.17031>`_.
Installation and requirements
-----------------------------
This package can be installed as
.. code:: bash
pip install epspy
It is recommended to work on a Python version > 3.8. Packages required are
- `numpy <https://pypi.org/project/numpy/>`_
- `scipy <https://pypi.org/project/scipy/>`_
- `matplotlib <https://pypi.org/project/matplotlib/>`_
- `mpi4py <https://pypi.org/project/mpi4py/>`_
- `healpy <https://pypi.org/project/healpy/>`_
- `transformcl <https://pypi.org/project/transformcl/>`_
Quick start
-----------
The code is run in two main steps:
- Assign the point sources flux densities (at a chosen reference frequency) and spectral indices.
- Then generate the sky maps at desired frequencies of observation.
The following code captures the main functionalities of this package.
.. code:: python
from epspy import meps
#Step-1 initialise the object with default settings
obj = meps.eps()
#Step-2 generate the data at the reference frequency
obj.ref_freq()
#Step-3 generate the sky maps at multiple frequencies as well as their sky average
obj.gen_freq()
#Step-4 finally, generate a sky averaged spectrum vs frequency figure
obj.visual()
Save the above code as (say) ``eg_script.py`` and run it as
.. code:: bash
python eg_script.py
Running the above will generate several files. The terminal messages will guide you to these output files. The most important of all files of your interest will be ``Tb_nu_map.npy``. To visualise your outputs use the function ``visual()``. Refer to the documentation for more details. To learn about the physics of this package see our `paper <https://arxiv.org/abs/2406.17031>`_.
The default values in this package have been chosen such that the users can run their scripts on a PC. Since modern PCs have at least 4 cores, for a better performance, one could also run ``eg_script.py`` parallely as
.. code:: bash
mpirun -np 4 python eg_script.py
In general, and for more realistic flux density ranges and high resolution maps, it is recommended to use the code on high performance clusters.
Documentation
-------------
For more details on the working of the package and understanding the output files refer to the documentation.
License and citation
--------------------
The software is free to use on the MIT open source license. If you use the software then please consider citing `Mittal et al (2024) <https://arxiv.org/abs/2406.17031>`_.
Contact
-------
In case of any confusion or suggestions for improvement please do not hesitate to contact me.
Raw data
{
"_id": null,
"home_page": null,
"name": "epspy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "extragalactic, foregrounds, point sources",
"author": null,
"author_email": "Shikhar Mittal <shikhar.mittal4@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/07/63/6a4100772bdf9d1b2bc12c74bac1a2a849d59853c0a8638ac20a3265409f/epspy-1.0.0.tar.gz",
"platform": null,
"description": "Overview\n--------\n\n:Name: Extragalactic Point Sources\n:Author: `Shikhar Mittal <https://sites.google.com/view/shikharmittal/home>`_\n:Paper: `Mittal et al. (2024) <https://arxiv.org/abs/2406.17031>`_\n\nWhy do you need this code?\n--------------------------\n\nUse this code to generate the foregrounds due to extragalactic point sources.\n\nA cosmological global 21-cm signal hides under foregrounds due to galactic and extragalactic emissions. These foregrounds can easily be 4 to 5 orders of magnitude higher than the signal of interest. For a reliable inference it is important to accurately model these foregrounds. While we have a reasonable understanding of galactic emission (typically fit as log-log polynomial), we do not understand the extragalactic contributions. This package models the foregrounds due to extragalactic radio sources.\n\nRead more about it in the paper `Mittal et al (2024) <https://arxiv.org/abs/2406.17031>`_.\n\nInstallation and requirements\n-----------------------------\n\nThis package can be installed as\n\n.. code:: bash\n\n pip install epspy\n\nIt is recommended to work on a Python version > 3.8. Packages required are \n\n- `numpy <https://pypi.org/project/numpy/>`_\n- `scipy <https://pypi.org/project/scipy/>`_\n- `matplotlib <https://pypi.org/project/matplotlib/>`_\n- `mpi4py <https://pypi.org/project/mpi4py/>`_\n- `healpy <https://pypi.org/project/healpy/>`_\n- `transformcl <https://pypi.org/project/transformcl/>`_\n\n\nQuick start\n-----------\n\nThe code is run in two main steps:\n\n- Assign the point sources flux densities (at a chosen reference frequency) and spectral indices.\n- Then generate the sky maps at desired frequencies of observation.\n\nThe following code captures the main functionalities of this package.\n\n.. code:: python\n\n from epspy import meps\n\n #Step-1 initialise the object with default settings\n obj = meps.eps()\n\n #Step-2 generate the data at the reference frequency\n obj.ref_freq()\n\n #Step-3 generate the sky maps at multiple frequencies as well as their sky average\n obj.gen_freq()\n\n #Step-4 finally, generate a sky averaged spectrum vs frequency figure\n obj.visual()\n\n\nSave the above code as (say) ``eg_script.py`` and run it as\n\n.. code:: bash\n\n python eg_script.py\n\nRunning the above will generate several files. The terminal messages will guide you to these output files. The most important of all files of your interest will be ``Tb_nu_map.npy``. To visualise your outputs use the function ``visual()``. Refer to the documentation for more details. To learn about the physics of this package see our `paper <https://arxiv.org/abs/2406.17031>`_.\n\nThe default values in this package have been chosen such that the users can run their scripts on a PC. Since modern PCs have at least 4 cores, for a better performance, one could also run ``eg_script.py`` parallely as \n\n.. code:: bash\n\n mpirun -np 4 python eg_script.py\n\nIn general, and for more realistic flux density ranges and high resolution maps, it is recommended to use the code on high performance clusters.\n\nDocumentation\n-------------\n\nFor more details on the working of the package and understanding the output files refer to the documentation. \n\nLicense and citation\n--------------------\n\nThe software is free to use on the MIT open source license. If you use the software then please consider citing `Mittal et al (2024) <https://arxiv.org/abs/2406.17031>`_.\n\nContact\n-------\n\nIn case of any confusion or suggestions for improvement please do not hesitate to contact me.\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Shikhar Mittal Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Extragalactic Point Sources",
"version": "1.0.0",
"project_urls": {
"Repository": "https://github.com/shikharmittal04/epspy.git"
},
"split_keywords": [
"extragalactic",
" foregrounds",
" point sources"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23a5541267325035d34297fcec8f872a2028b47fe397b31caf993f7980701d3c",
"md5": "1ac40124ccd1be643cca2a2372c545b4",
"sha256": "dc259998bb6e62f2e7b034988c574755abf5bec58cdf00aa4afc5fbd4dda8431"
},
"downloads": -1,
"filename": "epspy-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ac40124ccd1be643cca2a2372c545b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14252,
"upload_time": "2024-06-26T03:10:02",
"upload_time_iso_8601": "2024-06-26T03:10:02.865083Z",
"url": "https://files.pythonhosted.org/packages/23/a5/541267325035d34297fcec8f872a2028b47fe397b31caf993f7980701d3c/epspy-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "07636a4100772bdf9d1b2bc12c74bac1a2a849d59853c0a8638ac20a3265409f",
"md5": "2f3ece8af441f1ab021d401549394b7c",
"sha256": "ab64fcef142b794199c3b5705b7162054559bfaecb6731372d9f463312ae77f1"
},
"downloads": -1,
"filename": "epspy-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2f3ece8af441f1ab021d401549394b7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21851,
"upload_time": "2024-06-26T03:10:05",
"upload_time_iso_8601": "2024-06-26T03:10:05.526141Z",
"url": "https://files.pythonhosted.org/packages/07/63/6a4100772bdf9d1b2bc12c74bac1a2a849d59853c0a8638ac20a3265409f/epspy-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-26 03:10:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shikharmittal04",
"github_project": "epspy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "epspy"
}
