pyhdust
========
**Analysis tools for multi-technique astronomical data and** *hdust* **models**.
|Tests|
.. |Tests| image:: https://github.com/danmoser/pyhdust/actions/workflows/main.yaml/badge.svg
:target: https://github.com/danmoser/pyhdust/actions/workflows/main.yaml
Full documentation at `pyhdust.readthedocs.io <http://pyhdust.readthedocs.io>`_.
**pyhdust** should be independent of plataform (Linux, Mac, Windows) and compatible with Python3 (3.6+).
If you make use of **pyhdust** in your work, please cite Section 2.1.4 my thesis (Faes 2015: `arXiv <https://arxiv.org/abs/1512.06094>`_, `ADS <https://ui.adsabs.harvard.edu/abs/2015PhDT........60F>`_, `BibTeX <https://ui.adsabs.harvard.edu/abs/2015PhDT........60F/exportcitation>`_).
How to install/uninstall
--------------------------
I strongly suggest users to use the ``pip`` plataform:
.. code:: bash
pip install pyhdust
**pyhdust** dependencies are constantly evolving. If you face an installation problem, check the `versioning page <https://pyhdust.readthedocs.io/versioning.html>`_.
If your are not the root of the system, add the flag ``--user`` to the command above. Dependencies (as filters efficiency and stellar evolution models) are included in the subdirectories.
.. warning::
Never combine ``sudo`` with ``--user``! Otherwise you will face critical permission problems for your packages!
.. note::
To use the **pyhdust** scripts, the binaries path of your pip installation directory must be in system ``PATH``. If you don't find them, adapt the following command to your ``$HOME/.bashrc``:
.. code:: bash
PATH=$PATH:~/.local/bin/
**pyhdust** requires numpy, six and astropy modules. Optionally, it makes use of:
- emcee
- matplotlib
- pandas
- pIDLy
- scipy
- wget
- xmltodict
To only **update** the package:
.. code:: bash
pip install -U --no-deps pyhdust
``-U`` forces the upgrade and ``--no-deps`` do not reinstall the dependent packages.
For other options, consult the `full documentation <http://pyhdust.readthedocs.io>`_.
How to use the modules
-------------------------
To make use of all routines, the suggestion is to import them as follows:
.. code:: python
import pyhdust as hdt
import pyhdust.beatlas as bat
import pyhdust.fieldstars as fls
import pyhdust.images as img
import pyhdust.input as inp
import pyhdust.interftools as intt
import pyhdust.jdcal as jdcal
import pyhdust.poltools as polt
import pyhdust.phc as phc
import pyhdust.rotstars as rot
import pyhdust.singscat as sst
import pyhdust.spectools as spt
import pyhdust.stats as stt
License
-----------
The code is free, available under the terms of the `GNU GPL v3.0 license <https://github.com/danmoser/pyhdust/blob/master/LICENSE>`_.
Raw data
{
"_id": null,
"home_page": "http://pyhdust.readthedocs.io",
"name": "pyhdust",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "astronomy, astrophysics, science, hdust, Be stars, spectroscopy, polarimetry, interferometry, radiative transfer, optical-interferometry",
"author": "Daniel M. Faes",
"author_email": "dmfaes@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/11/03/f1f8e65fcaf62dfdbf8e4e1673d845b17c12675fddec2fc08392d17efd3b/pyhdust-1.6.1.tar.gz",
"platform": null,
"description": "pyhdust\n========\n**Analysis tools for multi-technique astronomical data and** *hdust* **models**.\n\n|Tests| \n\n.. |Tests| image:: https://github.com/danmoser/pyhdust/actions/workflows/main.yaml/badge.svg\n :target: https://github.com/danmoser/pyhdust/actions/workflows/main.yaml\n\nFull documentation at `pyhdust.readthedocs.io <http://pyhdust.readthedocs.io>`_.\n\n**pyhdust** should be independent of plataform (Linux, Mac, Windows) and compatible with Python3 (3.6+).\n\nIf you make use of **pyhdust** in your work, please cite Section 2.1.4 my thesis (Faes 2015: `arXiv <https://arxiv.org/abs/1512.06094>`_, `ADS <https://ui.adsabs.harvard.edu/abs/2015PhDT........60F>`_, `BibTeX <https://ui.adsabs.harvard.edu/abs/2015PhDT........60F/exportcitation>`_).\n\n\nHow to install/uninstall\n--------------------------\nI strongly suggest users to use the ``pip`` plataform:\n\n.. code:: bash\n\n pip install pyhdust\n\n**pyhdust** dependencies are constantly evolving. If you face an installation problem, check the `versioning page <https://pyhdust.readthedocs.io/versioning.html>`_.\n\nIf your are not the root of the system, add the flag ``--user`` to the command above. Dependencies (as filters efficiency and stellar evolution models) are included in the subdirectories.\n\n.. warning::\n\n Never combine ``sudo`` with ``--user``! Otherwise you will face critical permission problems for your packages!\n\n.. note:: \n\n To use the **pyhdust** scripts, the binaries path of your pip installation directory must be in system ``PATH``. If you don't find them, adapt the following command to your ``$HOME/.bashrc``:\n\n .. code:: bash\n\n PATH=$PATH:~/.local/bin/\n\n\n**pyhdust** requires numpy, six and astropy modules. Optionally, it makes use of: \n\n - emcee\n - matplotlib\n - pandas\n - pIDLy\n - scipy\n - wget\n - xmltodict\n\nTo only **update** the package:\n\n.. code:: bash\n\n pip install -U --no-deps pyhdust\n\n``-U`` forces the upgrade and ``--no-deps`` do not reinstall the dependent packages. \n\nFor other options, consult the `full documentation <http://pyhdust.readthedocs.io>`_.\n\n\nHow to use the modules\n-------------------------\nTo make use of all routines, the suggestion is to import them as follows:\n\n.. code:: python\n\n import pyhdust as hdt\n import pyhdust.beatlas as bat\n import pyhdust.fieldstars as fls\n import pyhdust.images as img\n import pyhdust.input as inp\n import pyhdust.interftools as intt\n import pyhdust.jdcal as jdcal\n import pyhdust.poltools as polt\n import pyhdust.phc as phc\n import pyhdust.rotstars as rot\n import pyhdust.singscat as sst\n import pyhdust.spectools as spt\n import pyhdust.stats as stt\n\n\nLicense\n-----------\nThe code is free, available under the terms of the `GNU GPL v3.0 license <https://github.com/danmoser/pyhdust/blob/master/LICENSE>`_.\n",
"bugtrack_url": null,
"license": "GNU GPLv3.0",
"summary": "Analysis tools for multi-technique astronomical data and hdust models",
"version": "1.6.1",
"project_urls": {
"Homepage": "http://pyhdust.readthedocs.io"
},
"split_keywords": [
"astronomy",
" astrophysics",
" science",
" hdust",
" be stars",
" spectroscopy",
" polarimetry",
" interferometry",
" radiative transfer",
" optical-interferometry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1103f1f8e65fcaf62dfdbf8e4e1673d845b17c12675fddec2fc08392d17efd3b",
"md5": "06d42adbcab51b83092c255d20ed6349",
"sha256": "88ac3bf0ce6d7951c02dc9d758067312add232e9f7cc4e8eabfa14b88692353c"
},
"downloads": -1,
"filename": "pyhdust-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "06d42adbcab51b83092c255d20ed6349",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 28494718,
"upload_time": "2024-12-03T19:07:07",
"upload_time_iso_8601": "2024-12-03T19:07:07.418179Z",
"url": "https://files.pythonhosted.org/packages/11/03/f1f8e65fcaf62dfdbf8e4e1673d845b17c12675fddec2fc08392d17efd3b/pyhdust-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 19:07:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyhdust"
}
JSON