Skip to content

Commit

Permalink
Merge 54a394c into 640c8d8
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii committed Apr 10, 2019
2 parents 640c8d8 + 54a394c commit 4d93888
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,18 @@ Usage
=====

Particles are a key component when dealing with decays.
Refer to the [particle package](https://github.com/scikit-hep/particle) for how to deal with particles and PDG identification codes.
Refer to the `particle package`_ for how to deal with particles and PDG identification codes.

The primary way to use `decaylanguage.decay` is through the module provided to read in a language file and produce an output. For example, for GooFit, call:

DecFiles
--------

DecFiles describe decays. You can read files and query information about them.

DecayLanguage
-------------

The primary way to use ``decaylanguage.decay`` is through the module provided to read in a language file and produce an output. For example, for GooFit, call:

.. code-block:: bash
Expand All @@ -14,3 +23,5 @@ The primary way to use `decaylanguage.decay` is through the module provided to r
You can pipe the output to a file.

Examples of interaction with the API directly are provided in the ``/notebooks`` folder, including svg diagrams of lines.

.. particle package: https://github.com/scikit-hep/particle

0 comments on commit 4d93888

Please sign in to comment.