Skip to content

Commit

Permalink
Improve the README
Browse files Browse the repository at this point in the history
- Link to deployments
- Link to documentation sites
  • Loading branch information
jonathansick committed Jan 13, 2025
1 parent 7a79029 commit fee26e6
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,20 @@ Excellent applications for Times Square include:
- Quick-look data previewing
- Reports that incorporate live data sources

## Deployments of Times Square

| Link | User guide | Purpose |
| --------------------------------------------------------------------- | ----------------------------------------------------------------------------- | --------------------------- |
| [USDF RSP (dev)](https://usdf-rsp-dev.slac.stanford.edu/times-square) | [Documentation](https://rsp.lsst.io/v/usdfdev/guides/times-square/index.html) | For Rubin Observatory staff |
| [IDF (dev)](https://data-dev.lsst.cloud/times-square) | [Documentation](https://rsp.lsst.io/v/idfdev/guides/times-square/index.html) | For SQuaRE developers |

## Design and development

The design and architecture of Times Square is described in [SQR-062: The Times Square service for publishing parameterized Jupyter Notebooks in the Rubin Science platform](https://sqr-062.lsst.io).
Times Square uses [Noteburst](https://noteburst.lsst.io) ([GitHub](https://github.com/lsst-sqre/noteburst), [SQR-065](https://sqr-065.lsst.io)) to execute Jupyter Notebooks in Nublado (JupyterLab) instances, thereby mechanizing the RSP's notebook aspect.

This Times Square API service is developed at https://github.com/lsst-sqre/times-square.
It's user interface is part of [Squareone](https://github.com/lsst-sqre/squareone).
Its user interface is part of [Squareone](https://github.com/lsst-sqre/squareone).
Times Square is deployed with [Phalanx](https://phalanx.lsst.io/applications/times-square/index.html).

REST API and developer documentation is at [times-square.lsst.io](https://times-square.lsst.io) and deployment documentation is [available at phalanx.lsst.io](https://phalanx.lsst.io/applications/times-square/index.html).

0 comments on commit fee26e6

Please sign in to comment.