Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Description of ODD full chain example #1401

Merged
merged 23 commits into from
Aug 15, 2022

Conversation

andiwand
Copy link
Contributor

@andiwand andiwand commented Aug 8, 2022

Walk-through / guide of ODD full chain example

@andiwand andiwand added the Component - Documentation Affects the documentation label Aug 8, 2022
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 8, 2022

Codecov Report

Merging #1401 (e822442) into main (81e9573) will decrease coverage by 0.82%.
The diff coverage is n/a.

❗ Current head e822442 differs from pull request most recent head c3b8625. Consider uploading reports for the commit c3b8625 to get more accurate results

@@            Coverage Diff             @@
##             main    #1401      +/-   ##
==========================================
- Coverage   48.59%   47.76%   -0.83%     
==========================================
  Files         380      380              
  Lines       20577    20164     -413     
  Branches     9429     9387      -42     
==========================================
- Hits         9999     9632     -367     
+ Misses       4093     4083      -10     
+ Partials     6485     6449      -36     
Impacted Files Coverage Δ
Core/include/Acts/Utilities/Delegate.hpp 77.27% <0.00%> (-9.57%) ⬇️
Core/src/Material/MaterialSlab.cpp 47.36% <0.00%> (-7.18%) ⬇️
Core/include/Acts/Geometry/Extent.hpp 87.50% <0.00%> (-6.95%) ⬇️
...clude/Acts/EventData/detail/CalculateResiduals.hpp 50.00% <0.00%> (-5.56%) ⬇️
...cts/EventData/SingleCurvilinearTrackParameters.hpp 44.44% <0.00%> (-5.56%) ⬇️
Core/include/Acts/Surfaces/EllipseBounds.hpp 58.33% <0.00%> (-4.63%) ⬇️
Core/src/Visualization/EventDataView3D.cpp 25.00% <0.00%> (-4.42%) ⬇️
Core/include/Acts/Surfaces/TrapezoidBounds.hpp 70.00% <0.00%> (-3.92%) ⬇️
Core/src/Geometry/TrackingGeometryBuilder.cpp 61.11% <0.00%> (-3.89%) ⬇️
Core/include/Acts/Utilities/ThrowAssert.hpp 46.15% <0.00%> (-3.85%) ⬇️
... and 124 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@AJPfleger AJPfleger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few minor typos and missing language-denotations in codeblocks.

docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
docs/examples/full_chain_odd.md Outdated Show resolved Hide resolved
@andiwand
Copy link
Contributor Author

andiwand commented Aug 9, 2022

thank you for the extensive review @AJPfleger !

andiwand and others added 14 commits August 9, 2022 12:30
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
Co-authored-by: Alexander J. Pfleger <70842573+AJPfleger@users.noreply.github.com>
@paulgessinger paulgessinger added the 🚧 WIP Work-in-progress label Aug 10, 2022
@paulgessinger paulgessinger modified the milestone: next Aug 11, 2022
@paulgessinger paulgessinger changed the title docs: odd full chain docs: Description of ODD full chain example Aug 11, 2022
@andiwand
Copy link
Contributor Author

I wondered if you want to have a look at this @timadye

Co-authored-by: Tim Adye <T.J.Adye@rl.ac.uk>
andiwand and others added 2 commits August 15, 2022 16:13
Co-authored-by: Tim Adye <T.J.Adye@rl.ac.uk>
Co-authored-by: Tim Adye <T.J.Adye@rl.ac.uk>
@timadye
Copy link
Contributor

timadye commented Aug 15, 2022

Sorry for all the nit-picking. I also have a couple of questions:

  1. where is this linked into the rest of the documentation? Does that need inclusion in this PR?
  2. I'd really like to see an ITk example too! Is that on the cards?

@paulgessinger
Copy link
Member

It's already linked, but empty here https://acts.readthedocs.io/en/latest/examples/full_chain_odd.html @timadye

@andiwand
Copy link
Contributor Author

Sorry for all the nit-picking. I also have a couple of questions:

  1. where is this linked into the rest of the documentation? Does that need inclusion in this PR?
  2. I'd really like to see an ITk example too! Is that on the cards?

ad 1 the linking should already be done by #1387

ad 2 that is a good point I think we did not plan this @paulgessinger ?

@paulgessinger
Copy link
Member

We didn't make a specific plan, but it might be a good idea to have an ITk doc like this one. Could create a stub and/or list in on the project I made (https://github.com/orgs/acts-project/projects/3/views/1)?

Copy link
Contributor

@timadye timadye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, thanks!

@paulgessinger paulgessinger added automerge and removed 🚧 WIP Work-in-progress labels Aug 15, 2022
@kodiakhq kodiakhq bot merged commit b1cce93 into acts-project:main Aug 15, 2022
@andiwand andiwand deleted the docs-full-chain-odd branch August 15, 2022 15:38
@paulgessinger paulgessinger modified the milestones: next, v20.0.0 Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Affects the documentation
Projects
Documentation
  
Awaiting triage
Development

Successfully merging this pull request may close these issues.

None yet

4 participants