Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-18017

Update ap_pipe docs to reflect new ppdb configs

    Details

    • Type: Story
    • Status: Invalid
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ap_pipe
    • Labels:
      None

      Description

      The docs still have an old example of how to run ap_pipe

      ap_pipe.py repo --calib repo/calibs --output path/to/put/processed/data/in -c associator.level1_db.db_name=ppdb/association.db --id visit=123456 ccdnum=42 filter=g --template path/to/templates
      

      This needs to be updated to something closer to

      ap_pipe.py repo --calib repo/calibs --output path/to/put/processed/data/in -c -c ppdb.db_url="sqlite:////absolute/path/to/database" -c ppdb.isolation_level="READ_UNCOMMITTED" --id visit=123456 ccdnum=42 filter=g
      

        Attachments

          Issue Links

            Activity

            Hide
            swinbank John Swinbank added a comment -

            Do you happen to remember which docs this refers to?

            I see a line something like the above in README.md (which I propose to simply remove, because it's duplicating the docs which are actually in the docs!) and in pipeline-tutorial.rst, which looks like it was modernized on DM-16606.

            Show
            swinbank John Swinbank added a comment - Do you happen to remember which docs this refers to? I see a line something like the above in README.md (which I propose to simply remove, because it's duplicating the docs which are actually in the docs!) and in pipeline-tutorial.rst , which looks like it was modernized on DM-16606 .
            Hide
            mrawls Meredith Rawls added a comment -

            I think I was referring to both the README and the "docs which are actually in the docs" as you say. I agree we shouldn't have duplication in the README, and certainly not over-a-year-out-of-date duplication, whoops.

            The specificity of this ticket probably makes it invalid, though you could use it to essentially nuke the README (or perhaps have a friendly link to the nicely-rendered docs page). At any rate, the real docs should be correct per your and Krzysztof's latest updates to the new "diaPipe" config syntax in DM-23436.

            Show
            mrawls Meredith Rawls added a comment - I think I was referring to both the README and the "docs which are actually in the docs" as you say. I agree we shouldn't have duplication in the README, and certainly not over-a-year-out-of-date duplication, whoops. The specificity of this ticket probably makes it invalid, though you could use it to essentially nuke the README (or perhaps have a friendly link to the nicely-rendered docs page). At any rate, the real docs should be correct per your and Krzysztof's latest updates to the new "diaPipe" config syntax in DM-23436 .
            Hide
            swinbank John Swinbank added a comment -

            Thanks! I'll mark this as duplicating both the above tickets (which isn't quite true, but near enough) and close it as invalid. And I've just edited README.md on DM-23436, so I think that we're good to go.

            Show
            swinbank John Swinbank added a comment - Thanks! I'll mark this as duplicating both the above tickets (which isn't quite true, but near enough) and close it as invalid. And I've just edited README.md on DM-23436 , so I think that we're good to go.

              People

              • Assignee:
                mrawls Meredith Rawls
                Reporter:
                mrawls Meredith Rawls
                Watchers:
                John Swinbank, Meredith Rawls
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: