Skip to main content

Astronomical utilities for PANOPTES

Project description

PyPI version Build Status codecov Documentation Status

Utility functions for use within the PANOPTES ecosystem and for general astronomical processing.

This library defines a number of modules that contain useful functions as well as a few services.

See the full documentation at: https://panoptes-utils.readthedocs.io

Getting

See Docker for ways to run panoptes-utils services without installing to your host computer.

pip

To install type:

pip install panoptes-utils

Docker

Docker containers are available for running the panoptes-utils module and associated services, which also serve as the base container for all other PANOPTES related containers.

See our Docker documentation for details.

Using

Modules

The modules can be used as helper utilities anywhere you would like. See the complete documentation for details: https://panoptes-utils.readthedocs.io/en/latest/.

Services

The services can be run either from a docker image or from the installed script, as described below.

Config Server

A simple config param server. Runs as a Flask microservice that delivers JSON documents in response to requests for config key items.

Can be run from the installed script (defaults to http://localhost:6563/get-config):

$ bin/panoptes-config-server
* Serving Flask app "panoptes.utils.config.server" (lazy loading)
* Environment: production
  WARNING: This is a development server. Do not use it in a production deployment.
  Use a production WSGI server instead.
* Debug mode: off

Or inside a python process:

>>> from panoptes.utils.config.server import config_server
>>> from panoptes.utils.config import client

>>> server_process=config_server()

>>> client.get_config('location.horizon')
30.0

>>> server_process.terminate()  # Or just exit notebook/console

For more details and usage examples, see the config server README.

Development

Environment

There is a docker development environment that has a number of support modules installed. This also defaults to running a jupyter-lab instance with the $PANDIR folder as the root.

You should have all panoptes repositories for development (maybe POCS, panoptes-utils, panoptes-tutorials) inside the $PANDIR folder (default /var/panoptes). Ideally you have just run the install script at TODO: reference install script here..

You can then start the development environment by:

bin/panoptes-develop up

You can then connect to the provided url in your browser. The default password is panotpes, which is not supplied for security purposes but just to allow access.

The environment can be stopped with:

bin/panoptes-develop down

Logging

The panoptes-utils module uses loguru for logging, which also serves as the basis for the POCS logger (see Logger).

To access the logs for the module, you can import directly from the logger module, i.e., from panoptes.utils.logger import logger. This is a simple wrapper around luguru with no extra configuration:

>>> from panoptes.utils import CountdownTimer
>>> # No logs by default
>>> t0 = CountdownTimer(5)
>>> t0.sleep()
False

>>> # Enable the logs
>>> from panoptes.utils.logger import logger
>>> logger.enable('panoptes')

>>> t1 = CountdownTimer(5)
2020-03-04 06:42:50 | DEBUG | panoptes.utils.time:restart:162 - Restarting Timer (blocking) 5.00/5.00
>>> t1.sleep()
2020-03-04 06:42:53 | DEBUG | panoptes.utils.time:sleep:183 - Sleeping for 2.43 seconds
False

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for panoptes-utils, version 0.2.17
Filename, size File type Python version Upload date Hashes
Filename, size panoptes_utils-0.2.17-py2.py3-none-any.whl (81.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size panoptes-utils-0.2.17.tar.gz (3.9 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page