Skip to content

yutaozhou/binspec

 
 

Repository files navigation

BinSpec: Self-consistent binary star spectra

Tools for modeling and fitting the spectra of multiple-star systems.

Installation

Clone this repository and add the base path to your PYTHONPATH variable. Or just run code from the base directory.

Individual modules are imported separately, e.g:

import utils
import spectral_model
import fitting

The tutorial shows some simple use cases.

Citing this code

Authors

Dependencies

  • The spectral model and fitting routines require only Numpy and Scipy.
  • Routines to download and process APOGEE spectra require the apogee package developed and maintained by Jo Bovy, and Astropy.
  • Training a new neural network requires PyTorch (no GPUs required).
  • I develop this package in Python 3 using Anaconda. I've tried to maintain compatibility with Python 2.7, but I cannot guarantee that everything will behave as expected in Python 2.7.

Licensing

Copyright 2018 by Kareem El-Badry.

In brief, you can use, distribute, and change this package as you please.

This software is governed by the MIT License:

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.

About

For generating and fitting unresolved binary spectra

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 89.7%
  • Python 10.3%