Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Write more examples notebooks and docu for the ComPWA python modules #7

Closed
spflueger opened this issue Oct 30, 2018 · 0 comments · Fixed by #74
Closed

Write more examples notebooks and docu for the ComPWA python modules #7

spflueger opened this issue Oct 30, 2018 · 0 comments · Fixed by #74
Assignees
@spflueger
Labels
💡 Docs Improvements or additions to documentation 💡 Maintenance Refactoring or redesign ⚠️ Low

Comments

@spflueger
Copy link
Member

  • write docu in sphinx for the python modules of ComPWA
  • write more examples that will help the analysis user
    • how and where to specify a dynamical function for a decay?
    • how to read in a dataset from file
    • how to apply a fit result to a model again
@spflueger spflueger self-assigned this Oct 30, 2018
@spflueger spflueger changed the title Write docu and examples for the python expert system and plotting module Write more examples notebooks and docu for the ComPWA python modules Mar 21, 2019
@spflueger spflueger transferred this issue from ComPWA/ComPWA-legacy Oct 14, 2019
@spflueger spflueger added 💡 Docs Improvements or additions to documentation ⚠️ Low Status: Available labels Oct 14, 2019
@spflueger spflueger added ❔ Question Discuss this matter in the team Status: In Progress 💡 Maintenance Refactoring or redesign and removed Status: Available labels Nov 19, 2019
@spflueger spflueger removed the ❔ Question Discuss this matter in the team label Jan 13, 2020
This was referenced Mar 26, 2020
Closed
Merged
redeboer added a commit that referenced this issue Mar 31, 2020
@redeboer
docs: reorganise notebooks into workflow steps (#74)
735edc2 
* Closes #7
* Closes #32
* Closes #70
* Closes #72


* docs: reorganise notebooks into workflow steps

* docs: add previous/next buttons on top as well

* chore: remove dalitz fit script

* docs: rewrite workflow notebooks

* docs: fix cross-references

* docs: add download buttons for each notebook

* docs: set correct notebook cell types

* docs: switch to nbsphinx instead of nbconvert

Examples had to be moved and but are kept in the main directory with a
symlink
spatialaudio/nbsphinx#170

* docs: add copy button

* docs: add trick to execute cells on local build

* docs: add download buttons for each notebook

* docs: reduce bins in Dalitz plot

* docs: do not copy rst source files to build

* build: fix setup install_requires

* docs: remove copyright from website

* docs: fix links to download notebook

* docs: fix square value in Dalitz plots

* docs: fix nbsphinx_execute switch

* docs: move examples back to main directory

* docs: rename examples to usage

* docs: change maintainer email

* docs: fix latex rendering \gamma

* docs: add more API links and wrap notebook cells

* docs: correct typos

Implement suggestions from #74

* docs: implement new description expert system

Implement suggestion from #74

* docs: fix typo
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@spflueger spflueger

Labels
💡 Docs Improvements or additions to documentation 💡 Maintenance Refactoring or redesign ⚠️ Low
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: reorganise notebooks into workflow steps
1 participant
@spflueger