pyhdust


Namepyhdust JSON
Version 1.5.12 PyPI version JSON
download
home_pagehttp://pyhdust.readthedocs.io
SummaryAnalysis tools for multi-technique astronomical data and hdust models
upload_time2024-04-10 23:52:13
maintainerNone
docs_urlNone
authorDaniel M. Faes
requires_python>=3.6
licenseGNU GPLv3.0
keywords astronomy astrophysics science hdust be stars spectroscopy polarimetry interferometry radiative transfer optical-interferometry
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            pyhdust
========
**Analysis tools for multi-technique astronomical data and** *hdust* **models**.

Full documentation at `pyhdust.readthedocs.io <http://pyhdust.readthedocs.io>`_.

About *hdust* code: Carciofi & Bjorkman (`2006 <http://adsabs.harvard.edu/abs/2006ApJ...639.1081C>`_, `2008 <http://adsabs.harvard.edu/abs/2008ApJ...684.1374C>`_).

**pyhdust** should be independent of plataform (Linux, Mac, Windows) and compatible with any version of Python (superior or equal to 3.4).


How to install/uninstall
--------------------------
I strongly suggest users to use the ``pip`` plataform:

.. code:: bash

    pip install pyhdust

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/2a/a6/753d87bc8ec87f464d07bf44f24f8c0e240029e8c2356bc99053c67d9179/pyhdust-1.5.12.tar.gz",
    "platform": null,
    "description": "pyhdust\n========\n**Analysis tools for multi-technique astronomical data and** *hdust* **models**.\n\nFull documentation at `pyhdust.readthedocs.io <http://pyhdust.readthedocs.io>`_.\n\nAbout *hdust* code: Carciofi & Bjorkman (`2006 <http://adsabs.harvard.edu/abs/2006ApJ...639.1081C>`_, `2008 <http://adsabs.harvard.edu/abs/2008ApJ...684.1374C>`_).\n\n**pyhdust** should be independent of plataform (Linux, Mac, Windows) and compatible with any version of Python (superior or equal to 3.4).\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\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.5.12",
    "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": "2aa6753d87bc8ec87f464d07bf44f24f8c0e240029e8c2356bc99053c67d9179",
                "md5": "ee5ae50f1bb9c6c6929c8f8696d0f7e9",
                "sha256": "70a903e6043b425a7e812bfa6ca382dccfada2c77296882fa1a61ba9add4ad85"
            },
            "downloads": -1,
            "filename": "pyhdust-1.5.12.tar.gz",
            "has_sig": false,
            "md5_digest": "ee5ae50f1bb9c6c6929c8f8696d0f7e9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 28676457,
            "upload_time": "2024-04-10T23:52:13",
            "upload_time_iso_8601": "2024-04-10T23:52:13.564702Z",
            "url": "https://files.pythonhosted.org/packages/2a/a6/753d87bc8ec87f464d07bf44f24f8c0e240029e8c2356bc99053c67d9179/pyhdust-1.5.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-10 23:52:13",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pyhdust"
}
        
Elapsed time: 0.52517s