Adding more docs, readme, and new data package

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2018, Henry Fredrick Schreiner III
+Copyright (c) 2018, the decaylanguage developers
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following

MANIFEST.in

@@ -15,7 +15,7 @@ include AUTHORS.rst
 include CHANGELOG.rst
 include CONTRIBUTING.rst
 include LICENSE
-include README.rst
+include README.md
 include Pipfile
 
 include tox.ini .travis.yml .appveyor.yml

README.md

@@ -0,0 +1,120 @@
+[![DecayLanguage](images/DecayLanguage.png)](http://decaylanaguage.readthedocs.io/en/latest/)
+
+[![Documentation Status](https://readthedocs.org/projects/decaylanguage/badge/?style=flat)](https://readthedocs.org/projects/decaylanguage)
+[![Travis-CI Build Status](https://travis-ci.org/henryiii/decaylanguage.svg?branch=master)](https://travis-ci.org/henryiii/decaylanguage)
+[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/henryiii/decaylanguage?branch=master&svg=true)](https://ci.appveyor.com/project/HenrySchreiner/decaylanguage)
+[![Coverage Status](https://coveralls.io/repos/henryiii/decaylanguage/badge.svg?branch=master&service=github)](https://coveralls.io/github/henryiii/decaylanguage)
+[![PyPI Package latest release](https://img.shields.io/pypi/v/decaylanguage.svg)](https://pypi.python.org/pypi/decaylanguage)
+[![Supported versions](https://img.shields.io/pypi/pyversions/decaylanguage.svg)](https://pypi.python.org/pypi/decaylanguage)
+[![Commits since latest release](https://img.shields.io/github/commits-since/henryiii/decaylanguage/v0.1.0.svg)](https://github.com/henryiii/decaylanguage/compare/v0.1.0...master)
+
+A language to describe particle decays, and tools to work with them.
+
+# Installation
+
+Just run the following:
+
+```bash
+pip install decaylanguage
+```
+
+You can use a virtual environment through pipenv or with `--user` if you know
+what those are. [Python 2.7 and 3.4+](http://docs.python-guide.org/en/latest/starting/installation) are supported. 
+
+<details><summary>Dependencies: (click to expand)</summary><p>
+
+Required and compatibility dependencies will be automatically installed by pip.
+
+### Required dependencies:
+
+-   [Numpy](https://scipy.org/install.html): The numerical library for Python
+-   [pandas](https://pandas.pydata.org/): Tabular data in Python
+-   [attrs](https://github.com/python-attrs/attrs): DataClasses for Python
+-   [plumbum](https://github.com/tomerfiliba/plumbum): Command line tools
+
+### Python compatibility:
+-   [six](https://github.com/benjaminp/six): Compatibility library
+-   [pathlib2](https://github.com/mcmtroffaes/pathlib2) backport if using Python 2.7
+-   [enum34](https://bitbucket.org/stoneleaf/enum34) backport if using Python /< 3.5
+-   [importlib_resources](http://importlib-resources.readthedocs.io/en/latest/) backport if using Python /< 3.7
+
+
+### Recommended dependencies:
+-   [graphviz](https://gitlab.com/graphviz/graphviz/) to render (DOT
+    language) graph descriptions of decay chains.
+</p></details>
+
+
+# Usage
+
+This is a quick user guide; for full API docs, go [here](https://decaylanguage.readthedocs.io/en/latest/).
+
+DecayLanguage is a set of tools for building and transforming particle
+decays. The parts are:
+
+## Particles
+
+You can use a variety of methods to get particles; if you know the PDG
+number you can get a particle directly, or you can use a search:
+
+```python
+Particle.from_pdgid(211)
+Particle.from_search_list(name='pi')[0]
+```
+
+You can search for the properties, which are `name`, `mass`, `width`,
+`charge`, `A`, `rank`, `I`, `J`, `G`, `P`, `quarks`, `status`, `latex`,
+`mass_upper`, `mass_lower`, `width_upper`, and `width_lower` (some of
+those don\'t make sense). You can also use `from_search` to require only
+one match.
+
+Once you have a particle, any of the properties can be accessed, along
+with several methods. Though they are not real properties, you can
+access `bar`, `radius`, and `spin_type`. You can also `invert()` a
+particle. There are lots of printing choices, `describe()`,
+`programmatic_name()`, `html_name()`, html printing outs in notebooks,
+and of course `repr` and `str` support.
+
+## Decays
+
+The most common way to create a decay chain is to read in an [AmpGen]
+style syntax from a file or a string. You can use:
+
+```python
+from decaylanguage.decay import AmplitudeChain
+lines, parameters, constants, states = AmplitudeChain.read_AmpGen(text='''
+EventType D0 K- pi+ pi+ pi-
+
+D0[D]{K*(892)bar0{K-,pi+},rho(770)0{pi+,pi-}}                            0 1 0.1 0 1 0.1
+
+K(1460)bar-_mass  0 1460 1
+K(1460)bar-_width 0  250 1
+
+a(1)(1260)+::Spline::Min 0.18412
+a(1)(1260)+::Spline::Max 1.86869
+a(1)(1260)+::Spline::N 34
+''')
+```
+
+Here, `lines` will be a list of AmplitudeChain lines (pretty print supported in Jupyter notebooks), 
+`parameters` will be a table of parameters (ranged parameters not yet supported),
+`constants` will be a table of constants,
+and `states` will be the list of known states (EventType).
+
+## Converters
+
+You can output to a format (currently only [GooFit] supported, feel free
+to make a PR to add more). Use a subclass of DecayChain, in this case,
+GooFitChain. To use the [GooFit] output, type from the shell:
+
+```bash
+python -m decaylanguage.decay -G goofit myinput.opts
+```
+
+# Acknowledgements
+
+DecayLanguage is free software released under a BSD 3-Clause License.
+It was originally developed by Henry Schreiner.
+
+[AmpGen]: https://gitlab.cern.ch/lhcb/Gauss/tree/LHCBGAUSS-1058.AmpGenDev/Gen/AmpGen
+[GooFit]: https://GooFit.github.io

decaylanguage/goofit.py → decaylanguage/__main__.py

@@ -10,13 +10,16 @@
 from decaylanguage.decay.ampgen2goofit import ampgen2goofit
 
 
-class AmpGen2GooFit(cli.Application):
+class DecayLanguageDecay(cli.Application):
+    generator = cli.SwitchAttr('-G,--generator', cli.Set('goofit'))
+
     def main(self, filename):
-        ampgen2goofit(filename)
+        if self.generator == 'goofit':
+            ampgen2goofit(filename)
 
 
 def main():
-    AmpGen2GooFit.run()
+    DecayLanguageDecay.run()
 
 
 if __name__ == "__main__":

decaylanguage/data/__init__.py

@@ -0,0 +1,16 @@
+try:
+    from importlib.resources import open_text
+except ImportError:
+    from importlib_resources import open_text
+
+
+def get_mass_width():
+    return open_text('decaylanguage.data', 'mass_width_2008.csv')
+
+
+def get_special():
+    return open_text('decaylanguage.data', 'MintDalitzSpecialParticles.csv')
+
+
+def get_latex():
+    return open_text('decaylanguage.data', 'pdgID_to_latex.txt')