Skip to content
Snippets Groups Projects

Fix doc pipeline & add documentation on running HLT1 and HLT2 over simulation

Merged Ross John Hunter requested to merge rjhunter-moore-docs-updates into master

FYI @mvesteri @decianm

This MR adds a new page to the documentation to show (and explain) how to run HLT1 and HLT2 over MC. It uses literal-include to grab code for examples that are tested in the nightlies, so the code examples will not become outdated unless they stop being tested.

There's pressure from OPG to get these instructions out, so I intend to just add the page, advertise it, and fix the doc build for now. Over the next few weeks, the Moore documentation needs a bit of a top-level reorganisation, which I'll do as a follow-up.

The new web page can be found at https://rjhunter.web.cern.ch/tutorials/running_over_mc.html

I also made a few hacks to get the docs to build.

TODO:

  • Improve on hacks
  • Put the pages on a web space so people can see them
  • Use call_allen_decision_logger() for more helpful HLT1 example
  • Add a bit about what conditions_version means
Edited by Ross John Hunter

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Ross John Hunter marked the checklist item Put the pages on a web space so people can see them as completed

    marked the checklist item Put the pages on a web space so people can see them as completed

  • Ross John Hunter changed the description

    changed the description

  • Ross John Hunter added 22 commits

    added 22 commits

    • 1fad4b02...85c1a17b - 16 commits from branch master
    • cb0a2900 - Hack around recent error to get docs to build
    • 20adc4a3 - use correct title types in hlt1 to hlt2 tutorial so it appears as only 1 page...
    • 87bdd325 - Upgrade to Sphinx5.0 to get docs to build
    • a5ba29c6 - First punt at a running HLT2 over simulation page
    • 91253923 - Register new page in the index
    • dd2225e0 - Rearrange a bit and hopefully fix linkcheck

    Compare with previous version

  • Ross John Hunter added 19 commits

    added 19 commits

    • dd2225e0...e934ef19 - 12 commits from branch master
    • 8578f934 - Hack around recent error to get docs to build
    • b6396781 - use correct title types in hlt1 to hlt2 tutorial so it appears as only 1 page...
    • 4225bff2 - Upgrade to Sphinx5.0 to get docs to build
    • 2bdb0b82 - First punt at a running HLT2 over simulation page
    • 5d91e744 - Register new page in the index
    • fbe0cf89 - Rearrange a bit and hopefully fix linkcheck
    • 906f67f6 - Add a little about what options.geometry_version means

    Compare with previous version

  • Ross John Hunter added 2 commits

    added 2 commits

    • 541407c3 - Add simple allen-via-moore options file
    • 65b1ca08 - Write about the HLT1 example and check off a point to be addressed

    Compare with previous version

  • Ross John Hunter added 2 commits

    added 2 commits

    • fe5183dc - Add attempt at test for last options file
    • 858e606d - Add copyright statement to new options file'

    Compare with previous version

  • Ross John Hunter added 2 commits

    added 2 commits

    • 4e03542b - Rename tutorial to reflect that it does HLT1 as well
    • 7a677d0c - Fix formatting

    Compare with previous version

  • Ross John Hunter changed title from Draft: Add documentation on running HLT2 over simulation to Draft: Add documentation on running HLT1 and HLT2 over simulation

    changed title from Draft: Add documentation on running HLT2 over simulation to Draft: Add documentation on running HLT1 and HLT2 over simulation

  • Ross John Hunter changed the description

    changed the description

  • Ross John Hunter added 2 commits

    added 2 commits

    • 3d07012e - Simplify example - couldnt get the logger to work yet
    • c04d13c3 - Simplify description accordingly in docs

    Compare with previous version

  • added 1 commit

    Compare with previous version

  • added 1 commit

    Compare with previous version

  • Ross John Hunter changed the description

    changed the description

  • Ross John Hunter added 3 commits

    added 3 commits

    • 5a287e11 - A few aesthetic fixes
    • 59f2d8e9 - Add a few catches for different configuration parameters you may need to give
    • 2655edf5 - Correct bit on reco from file =True by default

    Compare with previous version

  • added 1 commit

    Compare with previous version

  • Ross John Hunter added 47 commits

    added 47 commits

    • a8e89ffa...805a1022 - 24 commits from branch master
    • 805a1022...6328d308 - 13 earlier commits
    • 5ea7d39d - Simplify example - couldnt get the logger to work yet
    • fdab1bfa - Simplify description accordingly in docs
    • 6c8e852a - Please doc build
    • 77673a65 - Please the liner
    • 6c8cb429 - A few aesthetic fixes
    • 00001eab - Add a few catches for different configuration parameters you may need to give
    • 0d6ae01a - Correct bit on reco from file =True by default
    • 3aaf732c - Fix a link
    • 05684914 - Fix a few linting errors and add some temp debugging statements to isolate the doc failure
    • 6e64ae74 - Improve on hacks in fixing documentation, and fix some linter errors, wrong...

    Compare with previous version

  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading