Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/danmoser/pyhdust

Analysis tools for multi-technique astronomical data and hdust models
https://github.com/danmoser/pyhdust

astronomy astrophysics python

Last synced: 26 days ago
JSON representation

Analysis tools for multi-technique astronomical data and hdust models

Awesome Lists containing this project

README

        

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 `_.

About *hdust* code: Carciofi & Bjorkman (`2006 `_, `2008 `_).

**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 `_.

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 `_.