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: improve documentation with plots #142

Merged
merged 2 commits into from
Oct 28, 2020
Merged

docs: improve documentation with plots #142

merged 2 commits into from
Oct 28, 2020

Conversation

redeboer
Copy link
Member

@redeboer redeboer commented Oct 27, 2020

Summary of changes:

  • Removed text about downloading the notebook, because this is already proivded by the Sphinx Book theme.
  • Explained a bit more about the example decay channel
  • Use all f0 resonances in the example decay channel
  • Show how to convert the state IDs to particle names
  • Illustrate how to plot the fit result with matplotlib
  • Added a snippet that shows how to indicate the resonance positions in the plots
  • Added a snippet for exporting the fit result (but it's not yet used to import it back)

@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label Oct 27, 2020
@codecov
Copy link

codecov bot commented Oct 27, 2020

Codecov Report

Merging #142 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #142   +/-   ##
=======================================
  Coverage   72.43%   72.43%           
=======================================
  Files           8        8           
  Lines         584      584           
  Branches       83       83           
=======================================
  Hits          423      423           
  Misses        131      131           
  Partials       30       30           
Flag Coverage Δ
#unittests 72.43% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@redeboer
Copy link
Member Author

@Leongrim @sebastianJaeger These changes additions are to help you guys, could you have a look?

@spflueger You can have a look as well, but I did not modify the source code.

@redeboer
Copy link
Member Author

So for the record: best to review the rendered pages
https://pwa--142.org.readthedocs.build/projects/tensorwaves/en/142/usage.html

You can also download the notebooks from there (upper right) and run them yourself to see if you would like to add some more code snippets that are interesting to the physicist. (Better would of course be to checkout the branch of this PR.)

@Leongrim
Copy link
Contributor

In Step 2 it is mentioned that not all the invariant masses are registered. Are all the angles registered?

@redeboer
Copy link
Member Author

redeboer commented Oct 27, 2020

Good point. Actually it's just a quick remark that had to be there while #122 is still out there.

Unfortunately, the PR preview does not render output, but from the master branch, I see this:

>>> data_set = kin.convert(data_sample)
>>> list(data_set.keys())
['mSq_2_3_4',
 'mSq_3_4',
 'mSq_2',
 'mSq_3',
 'mSq_4',
 'theta+3_4+2',
 'phi+3_4+2',
 'theta+3+4_vs_2',
 'phi+3+4_vs_2']

Meaning also only the angles of the relevant subsystems are not generated. The best solution would be to create some register_all_subsystem method (to solve #122), just like ComPWA's createAllSubsystems. It's better to offer that as a method (not the default behaviour), because having all subsystems generated by default would create large data sets.

@redeboer redeboer merged commit 41b8af1 into ComPWA:master Oct 28, 2020
@redeboer redeboer deleted the docplots branch October 28, 2020 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants