Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mkelley authored Aug 30, 2024
1 parent 99bc0e2 commit 7eee659
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# SBN Survey Image Service

Live at the PDS [Small Bodies Node](https://sbnsurveys.astro.umd.edu/api/ui)

## What is This?

The SBN Survey Image Service is a REST API that enables a user to retrieve archive images and cutouts thereof from the Planetary Data System's Small-Bodies Node (PDS SBN). For example, a user may request a full-frame image from the ATLAS survey archive, or a small cutout around their object of interest. The returned data may be in FITS, JPEG, or PNG formats. The service can also return the image's PDS label.

![SBN Survey Image Service workflow](docs/_static/SBNSIS-workflow.png)

The [SBN Survey Image Service](https://sbnsurveys.astro.umd.edu/api/ui) (SIS) is deployed and available for [PDS Small-Bodies Node](https://pds-smallbodies.astro.umd.edu/) survey holdings. See the [API User’s Guide](https://sbn-survey-image-service.readthedocs.io/en/latest/api-guide.html) or the [API documentation](https://sbnsurveys.astro.umd.edu/api/ui) for details.

## Code Features

- Uses [fitscut](https://github.com/spacetelescope/fitscut) for image cutouts and JPEG/PNG generation
Expand All @@ -18,5 +18,5 @@ The SBN Survey Image Service is a REST API that enables a user to retrieve archi

## Documentation

Documentation is provided in the docs directory, and at
![readthedocs](https://sbn-survey-image-service.readthedocs.io).
Documentation is provided in the ``/docs`` directory, and at
[readthedocs](https://sbn-survey-image-service.readthedocs.io).

0 comments on commit 7eee659

Please sign in to comment.