Skip to content

Commit

Permalink
README - link to more comprehensive doc
Browse files Browse the repository at this point in the history
docs/index.rst - fix typo
docs/ops-rehearsals-3-4/SSO.rst -  Define "SSO"
  • Loading branch information
JoanneBogart committed Dec 2, 2024
1 parent 879f9ad commit 5584fa0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# The skyCatalogs package

This package will contain
This package contains
* code to create sky catalogs from input like cosmoDC2 (for galaxies) and similar catalogs for other source types
* implement an API to access information in the catalogs and products, such as flux calculations, derived from the catalogs
* an API to access information in the catalogs and products, such as flux calculations, derived from the catalogs

Sky Catalogs are chiefly intended for use by simulation programs. The physical representation is meant to compactly represent information needed to compute fluxes at a given time, under specified conditions (e.g. band).

For more complete information on installation and use see
[https://lsstdesc.org/skyCatalogs/](https://lsstdesc.org/skyCatalogs/)

## Set-up and testing
From bash
```
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ https://github.com/LSSTDESC/skyCatalogs.
:caption: Reference:
:hidden:

reeference_python
reference_python

.. toctree::
:maxdepth: 2
Expand Down
6 changes: 3 additions & 3 deletions docs/ops-rehearsals-3-4/SSO.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++++++++++++++++++++++++++++++++++++++++
SSO quantities for ops-rehearsals 3 and 4
+++++++++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Solar System Object (SSO) quantities for ops-rehearsals 3 and 4
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Data are partitioned by (nside=32, ring ordering) healpixel. For each pixel
there is a so-called "main file" and a flux file. The latter contains
for each object only fluxes for lsst bands, the object id and the time (mjd)
Expand Down

0 comments on commit 5584fa0

Please sign in to comment.