Skip to content

Commit

Permalink
Merge pull request #6 from bmorris3/docs
Browse files Browse the repository at this point in the history
Doc example fix
  • Loading branch information
tzdwi committed Oct 31, 2017
2 parents c514a44 + 28b750c commit 788d35f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
3 changes: 2 additions & 1 deletion aesop/tests/test_spectrum1d.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ def test_continuum_norm():

# Make sure that the continuum normalization is always good to 2%
polynomial_order = 8
target_spectrum.continuum_normalize(standard_spectrum, polynomial_order)
target_spectrum.continuum_normalize_from_standard(standard_spectrum,
polynomial_order)

for order in target_spectrum.spectrum_list:
assert abs(np.median(order.flux) - 1) < 0.02
Expand Down
10 changes: 5 additions & 5 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ The `~aesop.EchelleSpectrum` object behaves a bit like a Python list -- it
supports indexing, where the index counts the order number, starting with index
zero for the order with the shortest wavelengths. Elements of the
`~aesop.EchelleSpectrum` are `~aesop.Spectrum1D` objects. Suppose you want to
make a quick plot of the 32nd order of the target's echelle spectrum:
make a quick plot of the 73rd order of the target's echelle spectrum:

.. code-block:: python
order32 = target_spectrum[32]
order32.plot()
order73 = target_spectrum[73]
order73.plot()
.. plot::

Expand All @@ -75,8 +75,8 @@ make a quick plot of the 32nd order of the target's echelle spectrum:
target_spectrum = EchelleSpectrum.from_fits(target_path)
standard_spectrum = EchelleSpectrum.from_fits(standard_path)

order32 = target_spectrum[32]
order32.plot()
order73 = target_spectrum[73]
order73.plot()

import matplotlib.pyplot as plt
plt.show()
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can view the
`source code and submit issues via GitHub <https://github.com/bmorris3/aesop>`_.

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Contents:

install
Expand All @@ -26,4 +26,4 @@ Indices and tables

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`search`

0 comments on commit 788d35f

Please sign in to comment.