Skip to content

Commit

Permalink
update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
weaverba137 committed Sep 15, 2017
1 parent 16394fd commit 9674ae9
Showing 1 changed file with 46 additions and 4 deletions.
50 changes: 46 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,49 @@
----------------------------------
==================================
DESI Survey Planning and Scheduler
----------------------------------
==================================

This package provides the tools to plan and schedule observations of the predefined tiles in the DESI footprint, each associated with an observing program (DARK/GRAY/BRIGHT). The algorithms in this package do not deal with individual targets or their assignment to fibers.
Introduction
------------

See the ``surveysim`` package for a driver that uses randomly generated weather conditions to simulate a survey. In particular, this `tutorial <https://github.com/desihub/surveysim/blob/master/doc/tutorial.md>`__ is a good starting point.
This package provides the tools to plan and schedule observations of the
predefined tiles in the DESI footprint, each associated with an
observing program (DARK/GRAY/BRIGHT). The algorithms in this package
do not deal with individual targets or their assignment to fibers.

See the `surveysim <https://github.com/desihub/surveysim`_ package
for a driver that uses randomly generated weather conditions to
simulate a survey. In particular, this
`tutorial <https://github.com/desihub/surveysim/blob/master/doc/tutorial.rst>`_
is a good starting point.

Full Documentation
------------------

Please visit `desisurvey on Read the Docs`_

.. image:: https://readthedocs.org/projects/desisurvey/badge/?version=latest
:target: http://desisurvey.readthedocs.io/en/latest/
:alt: Documentation Status

.. _`desisurvey on Read the Docs`: http://desisurvey.readthedocs.io/en/latest/

Travis Build Status
-------------------

.. image:: https://img.shields.io/travis/desihub/desisurvey.svg
:target: https://travis-ci.org/desihub/desisurvey
:alt: Travis Build Status


Test Coverage Status
--------------------

.. image:: https://coveralls.io/repos/desihub/desisurvey/badge.svg?service=github
:target: https://coveralls.io/github/desihub/desisurvey
:alt: Test Coverage Status

License
-------

desisurvey is free software licensed under a 3-clause BSD-style license.
For details see the ``LICENSE.rst`` file.

0 comments on commit 9674ae9

Please sign in to comment.