For Jonathan to look at #8
Conversation
| All the information is generally applicable, but configuration paths will change | ||
| relative to what task is run in place of pipe_driver tasks. | ||
|
|
||
| Generating A Catlaog |
| and although the LSST stack supports many different cameras, at this point Synpipe | ||
| is currently limited to working with HSC data repositories. | ||
|
|
||
| This guide will assume processing will be done though the pipe_drivers scripts. |
| ######################### | ||
|
|
||
| Synpipe is a tool in the LSST software stack that is used to insert fake objects | ||
| into data that is to be processed with the sofware stack. Though Synpipe is not |
There was a problem hiding this comment.
"software"
Also, we generally use the name "LSST Science Pipelines" instead of "LSST software stack."
| frame. | ||
|
|
||
| Generating an input catalog for both stars and galaxies are done with the | ||
| `makeSourceList.py` command, but differ on some of the inputs. For either type |
There was a problem hiding this comment.
In reStructuredText, all these single backticks need to be double backticks to be recognized as code literals instead of Python API links.
| descriptions can be found within the script. | ||
| Listed below are all the configurations that may be set: | ||
|
|
||
| - rhoFakes : Number of fakes per patch in the specified tract. Defaults to 500 |
There was a problem hiding this comment.
Wrap the configuration names in double backticks.
doc/lsst.synpipe/index.rst
Outdated
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| Synpipe_QuickStart.rst |
There was a problem hiding this comment.
Please rename the file Synpipe_QuickStart.rst to quick-start.rst. I know I haven't published URL recommendations yet, but this will be it :)
doc/manifest.yaml
Outdated
|
|
||
| # Name of this package | ||
| # Also the name of the package documentation subdirectory. | ||
| package: "Synpipe" |
There was a problem hiding this comment.
The package name is the EUPS package name, so make it lowercase.
doc/manifest.yaml
Outdated
| # Name of the static content directories (subdirectories of `_static`). | ||
| # Static content directories are usually named after the package. | ||
| statics: | ||
| - "_static/Synpipe" |
doc/synpipe/index.rst
Outdated
| @@ -0,0 +1,27 @@ | |||
| .. _Synpipe-package: | |||
doc/synpipe/index.rst
Outdated
| .. Title is the EUPS package name | ||
|
|
||
| ####### | ||
| Synpipe |
There was a problem hiding this comment.
Yeah, make synpipe lowercase everywhere here.
Add in all the files necessary to use sphinx docs with Synpipe. Of note the api documentation is commented out until the package is converted to use numpy-doc docstrings
Add a quick-start guide for using synpipe to the sphinx documentation.
No description provided.