Welcome to pyhdust documentation!
Analysis tools for multi-technique astronomical data and hdust models. About the hdust code, see Carciofi & Bjorkman (2006, 2008).
Pyhdust is currently at version 1.5.11.
pyhdust should be independent of plataform (Linux, Mac, Windows) and compatible with any version of Python (3.6+).
- pyhdust: main module of Hdust tools
- bcd: module of BCD analysis tools
- beatlas: module of BeAtlas tools
- fieldstars: module of field stars tools
- hdrpil: auxiliary module to apply HDR to images
- images: module of image tools
- input: module of Hdust input tools
- interftools: module of interferometric tools
- jdcal: auxiliary module to convert between calendars
- oifits: auxiliary module to read and write oifits files
- phc: module of astronomical functions
- poltools: module of polarimetric tools
- releases: module to control PyHdust releases
- rotstars: module of rotating stars functions
- singscat: module of single scattering tools
- spectools: module of spectroscopic tools
- stats: module of statistical functions
- tabulate: auxiliary module to tablature matrix
- triangle: auxiliary module to MCMC plotting
How to install/uninstall
I strongly suggest users to use the pip
plataform:
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
:
PATH=$PATH:~/.local/bin/
pyhdust requires numpy and six modules. Optionally, it makes use of:
astropy
emcee
matplotlib
pandas
pIDLy
scipy
wget
xmltodict
To only update the package:
pip install -U --no-deps pyhdust
-U
forces the upgrade and --no-deps
do not reinstall the dependent packages.
To uninstall it:
pip uninstall pyhdust
Alternative procedures
See the Alternative download/installation page.
How to use the modules
To make use of all routines, the suggestion is to import them as follows:
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
How to contribute to the module
See the How to contribute to pyhdust page.
Indices and tables
License
The code is free, available under the terms of the GNU GPL v3.0 license.