Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
stharrold committed Apr 20, 2015
2 parents 7e6050d + f098acd commit 08452f0
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 12 deletions.
10 changes: 7 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,20 @@ CHANGELOG
* This project adheres to `Semantic Versioning <http://semver.org/>`_.
* This change log is adapted from to `Keep a CHANGELOG <http://keepachangelog.com/>`_.

[v0.1.3] - UNRELEASED
---------------------
[v0.1.3] - 20150419T220000
--------------------------
Added
^^^^^
* `Issue 26 <https://github.com/ccd-utexas/binstarsolver/issues/26>`_: Created binstarsolver Google group.
* `Issue 23 <https://github.com/ccd-utexas/binstarsolver/issues/23>`_: Created account on Zenodo for citations.
* `Issue 20 <https://github.com/ccd-utexas/binstarsolver/issues/20>`_: Added CHANGELOG.rst
* `Issue 18 <https://github.com/ccd-utexas/binstarsolver/issues/18>`_: Added IPython Notebook examples to distribution.

Fixed
^^^^^
* `Issue 19 <https://github.com/ccd-utexas/binstarsolver/issues/19>`_: Solver for inclination must give inclination < 90 deg.
* `Issue 22 <https://github.com/ccd-utexas/binstarsolver/issues/22>`_: Tests execute on local code, not installed.
* `Issue 21 <https://github.com/ccd-utexas/binstarsolver/issues/21>`_: Solver for inclination did not converge for special cases.
* `Issue 19 <https://github.com/ccd-utexas/binstarsolver/issues/19>`_: Solver for inclination must give inclination < 90 deg.

[v0.1.2] - 20150123T172000
--------------------------
Expand Down
23 changes: 19 additions & 4 deletions DESCRIPTION.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@ binstarsolver
=============

Overview
^^^^^^^^
--------

The purpose of this project is to estimate physical quantities of an eclipsing, spectroscopic binary star system using observed quantities from photometry and spectroscopy.
The estimated physical quantities serve as input to a more complete numerical model such as that of Wilson-Devinney, c.f. chapter 7 of [1]_.
The model used in this project is a simple, spherical detached binary star model with no orbital eccentricity and no limb darkening.
The model is from chapter 7 of [2]_ and chapter 7 of [3]_.

Input observed quantities
^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------

* Relative times of begin/end ingress/egress and mid-eclipse.
* Orbital period.
* Light levels during occultation (primary eclipse), transit (secondary eclipse), and outside of eclipse.
* Stellar radial velocities.

Output estimated physical quantities
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------------

* Orbital inclination angle.
* Orbital radii.
Expand All @@ -28,8 +28,23 @@ Output estimated physical quantities
* Ratio of stellar effective temperatures.
* Ratio of stellar luminosites.

Examples and Q&A forum
----------------------

* For explanations of examples, please see the `binstarsolver GitHub wiki <https://github.com/ccd-utexas/binstarsolver/wiki>`_.
* For questions and discussion, please see the `binstarsolver Google group <https://groups.google.com/forum/#!forum/binstarsolver>`_.
* Got a second for a `user survey <https://docs.google.com/forms/d/1vneANTMMaOdQSRvIm2OJYItgaTTbp4f9EM8ImKqwD-g/viewform>`_? I'd love your feedback! Thank you for being part of open science. (All survey responses are anonymous.)

Recent changes
--------------
* [v0.1.3] - 20150419T220000
- Created Google group, DOI for citations, CHANGELOG.rst, IPython Notebook examples.
- Fixed special cases where solver for inclination did not converge.
* [v0.1.2] - 20150123T172000
- Initial release to PyPI.

References
^^^^^^^^^^
----------

.. [1] `Kallrath and Milone, 2007, Eclipsing Binary Stars: Modeling and Analysis <https://books.google.com/books?id=CrXBnZFdjXgC>`_
.. [2] `Budding, 2007, Introduction to Astronomical Photometry <https://books.google.com/books?id=g_K3-bQ8lTUC>`_
Expand Down
12 changes: 8 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Estimate physical quantities of a binary star system from observed quantities.
Description
-----------

See DESCRIPTION.rst.
For the Python Packaging Index `binstarsolver <https://pypi.python.org/pypi/binstarsolver>`_ description, see DESCRIPTION.rst.

.. toctree::

Expand All @@ -15,15 +15,18 @@ See DESCRIPTION.rst.
Examples
--------

For explanations of examples, please see the `wiki <https://github.com/ccd-utexas/binstarsolver/wiki>`_.
For explanations of examples, please see the `GitHub wiki <https://github.com/ccd-utexas/binstarsolver/wiki>`_.
Contributions are always welcome!

Questions
Q&A Forum
---------

For questions and discussion, please see the `Google group <https://groups.google.com/forum/#!forum/binstarsolver>`_.
Contributions are always welcome!

Got a second for a `user survey <https://docs.google.com/forms/d/1vneANTMMaOdQSRvIm2OJYItgaTTbp4f9EM8ImKqwD-g/viewform>`_?
I'd love your feedback! Thank you for being part of open science. (All survey responses are anonymous.)

Installation
------------

Expand All @@ -50,7 +53,8 @@ Use `pytest <https://pytest.org>`_:
Contributing
------------

See CONTRIBUTING.rst.
For contributing code, please see CONTRIBUTING.rst.
For other ways to contribute, please see the sections Examples and Q&A Forum above.

.. toctree::

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
name='binstarsolver',
# Versions should comply with PEP440.
# https://packaging.python.org/en/latest/single_source_version.html
version='0.1.2',
version='0.1.3',
description='Estimate physical quantities of a binary star system from observed quantities.',
long_description=long_description,
url='http://binstarsolver.readthedocs.org',
Expand Down

0 comments on commit 08452f0

Please sign in to comment.