Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 3.51 KB

README.md

File metadata and controls

90 lines (60 loc) · 3.51 KB

Welcome to POCS documentation!

PAN001


GHA Status Travis Status codecov Documentation Status PyPI version

Project PANOPTES

PANOPTES is an open source citizen science project designed to find transiting exoplanets with digital cameras. The goal of PANOPTES is to establish a global network of of robotic cameras run by amateur astronomers and schools (or anyone!) in order to monitor, as continuously as possible, a very large number of stars. For more general information about the project, including the science case and resources for interested individuals, see the project overview.

POCS

POCS (PANOPTES Observatory Control System) is the main software driver for a PANOPTES unit, responsible for high-level control of the unit.

For more information, see the full documentation at: https://pocs.readthedocs.io.

panoptes-utils is a related repository and POCS relies on most of the tools within panoptes-utils.

Install

POCS Environment

If you are running a PANOPTES unit then you will most likely want an entire PANOPTES environment.

There is a bash shell script that will install an entire working POCS system on your computer. Some folks even report that it works on a Mac.

The script will ask if you want to install in "developer" mode or not. If so, you should fork this repo, panoptes-utils, and panoptes-tutorials, and then give your github username when prompted.

The non-developer mode of the script is intended for PANOPTES units.

To install POCS via the script, open a terminal and enter:

curl -fsSL https://install.projectpanoptes.org > install-pocs.sh
bash install-pocs.sh

Or using wget:

wget -qO- https://install.projectpanoptes.org > install-pocs.sh
bash install-pocs.sh

POCS Module

If you want just the POCS module, for instance if you want to override it in your own OCS (see Huntsman-POCS for an example), then install via pip:

pip install panoptes-pocs

If you want the extra features, such as Google Cloud Platform connectivity, then use the extras options:

pip install "panoptes-pocs[google,testing]"

See the full documentation at: https://pocs.readthedocs.io

For helping develop POCS software

See Coding in PANOPTES

Links