decaylanguage 0.3.0__tar.gz → 0.3.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/.coveragerc +18 -18
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/.editorconfig +13 -13
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/AUTHORS.rst +6 -6
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/CHANGELOG.md +63 -39
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/CONTRIBUTING.rst +90 -90
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/LICENSE +23 -23
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/MANIFEST.in +34 -34
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/PKG-INFO +276 -203
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/README.md +195 -146
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/__init__.py +14 -14
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/__main__.py +30 -30
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/_version.py +10 -10
- decaylanguage-0.3.2/decaylanguage/data/DECAY_BELLE.DEC +8828 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/data/DECAY_CLASSIC.DEC +10249 -10249
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/data/DECAY_LHCB.DEC +11657 -11678
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/data/MintDalitzSpecialParticles.csv +37 -37
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/data/MintDalitzSpecialParticles.fwf +41 -41
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/data/MintDalitzSpecialParticlesLatex.csv +15 -15
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/data/README.rst +51 -51
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/data/WorkingOutModel.ipynb +659 -659
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/data/__init__.py +4 -4
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/data/ampgen.lark +65 -65
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/data/decfile.lark +63 -61
- decaylanguage-0.3.2/decaylanguage/data/desktop.ini +2 -0
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/data/particle.lark +35 -35
- decaylanguage-0.3.2/decaylanguage/data/specifics.dec +79 -0
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/dec/__init__.py +3 -3
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/dec/dec.py +1262 -1213
- decaylanguage-0.3.0/notebooks/decaylanguage/dec/decparser.py → decaylanguage-0.3.2/decaylanguage/dec/decparser - Copy.py +420 -409
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/dec/decparser.py +409 -409
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/dec/enums.py +65 -62
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/decay/__init__.py +1 -1
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/decay/decay.py +243 -243
- decaylanguage-0.3.2/decaylanguage/decay/decaychain-wip.py +125 -0
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/decay/viewer.py +213 -182
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/modeling/__init__.py +4 -4
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/modeling/ampgen2goofit.py +86 -86
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/modeling/ampgentransform.py +49 -49
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/modeling/amplitudechain.py +277 -277
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/modeling/decay.py +123 -123
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/modeling/goofit.py +330 -330
- {decaylanguage-0.3.0/notebooks → decaylanguage-0.3.2}/decaylanguage/utils/__init__.py +8 -8
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/utils/errors.py +13 -13
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage/utils/utilities.py +56 -56
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage.egg-info/PKG-INFO +276 -203
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage.egg-info/SOURCES.txt +13 -32
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/authors.rst +1 -1
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/changelog.rst +1 -1
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/conf.py +53 -53
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/contributing.rst +1 -1
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/index.rst +22 -22
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/installation.rst +13 -13
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/readme.rst +1 -1
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/reference/decaylanguage.decay.rst +33 -33
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/reference/decaylanguage.rst +9 -9
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/reference/index.rst +7 -7
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/requirements.txt +3 -3
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/spelling_wordlist.txt +11 -11
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/docs/usage.rst +27 -27
- decaylanguage-0.3.2/images/DecayChain_Dst_stable-D0-and-D+.pdf +0 -0
- decaylanguage-0.3.2/images/DecayChain_Dst_stable-D0-and-D+.png +0 -0
- decaylanguage-0.3.2/images/DecayChain_Dstbar_stable-D0bar-and-D-.pdf +0 -0
- decaylanguage-0.3.2/images/DecayChain_Dstbar_stable-D0bar-and-D-.png +0 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/images/DecayLanguage.ink.svg +103 -103
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/images/DecayLanguage.svg +65 -65
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/models/DtoKpipipi_v2.txt +224 -224
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/notebooks/AmpGen2GooFit D2K3p.ipynb +1939 -1939
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/notebooks/DecReader.ipynb +859 -859
- decaylanguage-0.3.2/notebooks/DecayChainViewer.ipynb +732 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/notebooks/DecayLanguageDemo.ipynb +400 -405
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/notebooks/DtoKpipipi_v2.cu +1539 -1539
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/notebooks/ExampleDecFileParsingWithLark.ipynb +426 -426
- decaylanguage-0.3.2/notebooks/decaylanguage +1 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/notebooks/simple_model.txt +8 -8
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/setup.cfg +38 -38
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/setup.py +93 -93
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/README.rst +5 -5
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/defs-aliases-chargeconj.dec +278 -271
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/duplicate-decays.dec +40 -40
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/test_Bc2BsPi_Bs2KK.dec +22 -22
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/test_Bd2DDst_Ds2DmPi0.dec +53 -53
- decaylanguage-0.3.2/tests/data/test_Bd2DMuNu.dec +124 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/test_Bd2DmTauNu_Dm23PiPi0_Tau2MuNu.dec +42 -42
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/test_Bd2Dst0X_D02KPi.dec +127 -127
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/test_Bd2DstDst.dec +85 -85
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/test_Upsilon4S2B0B0bar.dec +8 -8
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/test_Xicc2XicPiPi.dec +16 -16
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/data/test_example_Dst.dec +30 -30
- {decaylanguage-0.3.0/tests → decaylanguage-0.3.2/tests/dec}/test_dec.py +411 -401
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/decay/test_decay.py +127 -127
- decaylanguage-0.3.2/tests/decay/test_viewer.py +88 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/output/DtoKpipipi_v2.cu +1539 -1539
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/test_convert.py +24 -24
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/test_dec_full.py +67 -67
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/test_decaylanguage.py +10 -10
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/test_goofit.py +28 -28
- decaylanguage-0.3.0/decaylanguage/__init__.py +0 -14
- decaylanguage-0.3.0/decaylanguage/data/README.rst +0 -51
- decaylanguage-0.3.0/decaylanguage/data/__init__.py +0 -4
- decaylanguage-0.3.0/decaylanguage/data/ampgen.lark +0 -65
- decaylanguage-0.3.0/decaylanguage/data/decfile.lark +0 -61
- decaylanguage-0.3.0/decaylanguage/data/particle.lark +0 -35
- decaylanguage-0.3.0/decaylanguage/dec/__init__.py +0 -3
- decaylanguage-0.3.0/decaylanguage/dec/dec.py +0 -1213
- decaylanguage-0.3.0/decaylanguage/dec/enums.py +0 -62
- decaylanguage-0.3.0/decaylanguage/decay/__init__.py +0 -1
- decaylanguage-0.3.0/decaylanguage/decay/decay.py +0 -243
- decaylanguage-0.3.0/decaylanguage/decay/viewer.py +0 -182
- decaylanguage-0.3.0/decaylanguage/modeling/__init__.py +0 -4
- decaylanguage-0.3.0/decaylanguage/modeling/ampgen2goofit.py +0 -86
- decaylanguage-0.3.0/decaylanguage/modeling/ampgentransform.py +0 -49
- decaylanguage-0.3.0/decaylanguage/utils/__init__.py +0 -8
- decaylanguage-0.3.0/notebooks/decaylanguage/__main__.py +0 -30
- decaylanguage-0.3.0/notebooks/decaylanguage/_version.py +0 -10
- decaylanguage-0.3.0/notebooks/decaylanguage/data/DECAY_CLASSIC.DEC +0 -10249
- decaylanguage-0.3.0/notebooks/decaylanguage/data/DECAY_LHCB.DEC +0 -11678
- decaylanguage-0.3.0/notebooks/decaylanguage/data/MintDalitzSpecialParticles.csv +0 -37
- decaylanguage-0.3.0/notebooks/decaylanguage/data/MintDalitzSpecialParticles.fwf +0 -41
- decaylanguage-0.3.0/notebooks/decaylanguage/data/MintDalitzSpecialParticlesLatex.csv +0 -15
- decaylanguage-0.3.0/notebooks/decaylanguage/data/WorkingOutModel.ipynb +0 -659
- decaylanguage-0.3.0/notebooks/decaylanguage/modeling/AmpGenReader.ipynb +0 -1607
- decaylanguage-0.3.0/notebooks/decaylanguage/modeling/amplitudechain.py +0 -277
- decaylanguage-0.3.0/notebooks/decaylanguage/modeling/decay.py +0 -123
- decaylanguage-0.3.0/notebooks/decaylanguage/modeling/goofit.py +0 -330
- decaylanguage-0.3.0/notebooks/decaylanguage/utils/errors.py +0 -13
- decaylanguage-0.3.0/notebooks/decaylanguage/utils/utilities.py +0 -56
- decaylanguage-0.3.0/tests/decay/test_viewer.py +0 -99
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage.egg-info/dependency_links.txt +0 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage.egg-info/requires.txt +0 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/decaylanguage.egg-info/top_level.txt +0 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/images/DecayLanguage.pdf +0 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/images/DecayLanguage.png +0 -0
- {decaylanguage-0.3.0 → decaylanguage-0.3.2}/tests/__init__.py +0 -0
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
[paths]
|
|
2
|
-
source =
|
|
3
|
-
decaylanguage
|
|
4
|
-
*/site-packages/decaylanguage
|
|
5
|
-
|
|
6
|
-
[run]
|
|
7
|
-
branch = true
|
|
8
|
-
source =
|
|
9
|
-
decaylanguage
|
|
10
|
-
parallel = true
|
|
11
|
-
omit =
|
|
12
|
-
# omit certain files
|
|
13
|
-
decaylanguage/__main__.py
|
|
14
|
-
|
|
15
|
-
[report]
|
|
16
|
-
show_missing = true
|
|
17
|
-
precision = 2
|
|
18
|
-
omit = *migrations*
|
|
1
|
+
[paths]
|
|
2
|
+
source =
|
|
3
|
+
decaylanguage
|
|
4
|
+
*/site-packages/decaylanguage
|
|
5
|
+
|
|
6
|
+
[run]
|
|
7
|
+
branch = true
|
|
8
|
+
source =
|
|
9
|
+
decaylanguage
|
|
10
|
+
parallel = true
|
|
11
|
+
omit =
|
|
12
|
+
# omit certain files
|
|
13
|
+
decaylanguage/__main__.py
|
|
14
|
+
|
|
15
|
+
[report]
|
|
16
|
+
show_missing = true
|
|
17
|
+
precision = 2
|
|
18
|
+
omit = *migrations*
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
# see http://editorconfig.org
|
|
2
|
-
root = true
|
|
3
|
-
|
|
4
|
-
[*]
|
|
5
|
-
end_of_line = lf
|
|
6
|
-
trim_trailing_whitespace = true
|
|
7
|
-
insert_final_newline = true
|
|
8
|
-
indent_style = space
|
|
9
|
-
indent_size = 4
|
|
10
|
-
charset = utf-8
|
|
11
|
-
|
|
12
|
-
[*.{bat,cmd,ps1}]
|
|
13
|
-
end_of_line = crlf
|
|
1
|
+
# see http://editorconfig.org
|
|
2
|
+
root = true
|
|
3
|
+
|
|
4
|
+
[*]
|
|
5
|
+
end_of_line = lf
|
|
6
|
+
trim_trailing_whitespace = true
|
|
7
|
+
insert_final_newline = true
|
|
8
|
+
indent_style = space
|
|
9
|
+
indent_size = 4
|
|
10
|
+
charset = utf-8
|
|
11
|
+
|
|
12
|
+
[*.{bat,cmd,ps1}]
|
|
13
|
+
end_of_line = crlf
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
Authors
|
|
3
|
-
=======
|
|
4
|
-
|
|
5
|
-
* Henry Fredrick Schreiner III - https://iscinumpy.gitlab.io
|
|
6
|
-
* Eduardo Rodrigues - https://github.com/eduardo-rodrigues/
|
|
1
|
+
|
|
2
|
+
Authors
|
|
3
|
+
=======
|
|
4
|
+
|
|
5
|
+
* Henry Fredrick Schreiner III - https://iscinumpy.gitlab.io
|
|
6
|
+
* Eduardo Rodrigues - https://github.com/eduardo-rodrigues/
|
|
@@ -1,39 +1,63 @@
|
|
|
1
|
-
# Changelog
|
|
2
|
-
|
|
3
|
-
## Version 0.3.
|
|
4
|
-
|
|
5
|
-
*
|
|
6
|
-
-
|
|
7
|
-
*
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
-
|
|
22
|
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
*
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## Version 0.3.2 (2019-08-29)
|
|
4
|
+
|
|
5
|
+
* Parsing of decay files (aka .dec files):
|
|
6
|
+
- ``DecFileParser`` class extended to understand JETSET definitions.
|
|
7
|
+
* Visualisation of decay chains:
|
|
8
|
+
- ``DecayChainViewer`` class simplified and improved.
|
|
9
|
+
- Decay chain DOT graphs now display HTML particle names.
|
|
10
|
+
- More tests.
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## Version 0.3.1 (2019-07-18)
|
|
14
|
+
|
|
15
|
+
* Parsing of decay files (aka .dec files):
|
|
16
|
+
- Update to latest LHCb DECAY.DEC file.
|
|
17
|
+
* Visualisation of decay chains:
|
|
18
|
+
- ``DecayChainViewer`` class made more robust.
|
|
19
|
+
- Better tests.
|
|
20
|
+
* Miscellaneous:
|
|
21
|
+
- Demo notebook updated.
|
|
22
|
+
- README updated with latest package functionality.
|
|
23
|
+
- Python wheels generation added.
|
|
24
|
+
- Zenodo DOI badge added to README.
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Version 0.3.0 (2019-06-26)
|
|
28
|
+
|
|
29
|
+
* Decays modelling:
|
|
30
|
+
- Updates to Mint related particle data files.
|
|
31
|
+
* Parsing of decay files (aka .dec files):
|
|
32
|
+
- Lark parser files added, for ``.dec`` decay files.
|
|
33
|
+
- ``DecFileParser`` class introduced, with documentation and test suite.
|
|
34
|
+
- Various ``.dec`` test decay files added.
|
|
35
|
+
* Visualisation of decay chains:
|
|
36
|
+
- ``DecayChainViewer`` class introduced, with documentation and test suite.
|
|
37
|
+
* Universal representation of decay chains:
|
|
38
|
+
- First "building block" classes ``DaughtersDict`` and ``DecayMode`` introduced,
|
|
39
|
+
with documentation and test suite.
|
|
40
|
+
* Package dependencies:
|
|
41
|
+
- Package made dependent on Scikit-HEP's ``Particle`` package.
|
|
42
|
+
- Redundant code removed.
|
|
43
|
+
* Continuous integration:
|
|
44
|
+
- CI with Azure pipelines introduced.
|
|
45
|
+
- CI with Travis and AppVeyor removed.
|
|
46
|
+
* Miscellaneous:
|
|
47
|
+
- Demo notebook added, with a launcher for Binder.
|
|
48
|
+
- Copyright statements added to repository files.
|
|
49
|
+
- General clean-up and minor bug fixes.
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
## Version 0.2.0 (2018-08-02)
|
|
53
|
+
|
|
54
|
+
* First release as part of Scikit-HEP.
|
|
55
|
+
* Using new data package with ``importlib_resources`` (or ``importlib.resources`` on Python 3.7).
|
|
56
|
+
* Better docs and examples.
|
|
57
|
+
* Some method renaming.
|
|
58
|
+
* Generalized converter script.
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
## Version 0.1.0 (2018-03-13)
|
|
62
|
+
|
|
63
|
+
* First release on PyPI.
|
|
@@ -1,90 +1,90 @@
|
|
|
1
|
-
============
|
|
2
|
-
Contributing
|
|
3
|
-
============
|
|
4
|
-
|
|
5
|
-
Contributions are welcome, and they are greatly appreciated! Every
|
|
6
|
-
little bit helps, and credit will always be given.
|
|
7
|
-
|
|
8
|
-
Bug reports
|
|
9
|
-
===========
|
|
10
|
-
|
|
11
|
-
When `reporting a bug <https://github.com/scikit-hep/decaylanguage/issues>`_ please include:
|
|
12
|
-
|
|
13
|
-
* Your operating system name and version.
|
|
14
|
-
* Any details about your local setup that might be helpful in troubleshooting.
|
|
15
|
-
* Detailed steps to reproduce the bug.
|
|
16
|
-
|
|
17
|
-
Documentation improvements
|
|
18
|
-
==========================
|
|
19
|
-
|
|
20
|
-
decaylanguage could always use more documentation, whether as part of the
|
|
21
|
-
official decaylanguage docs, in docstrings, or even on the web in blog posts,
|
|
22
|
-
articles, and such.
|
|
23
|
-
|
|
24
|
-
Feature requests and feedback
|
|
25
|
-
=============================
|
|
26
|
-
|
|
27
|
-
The best way to send feedback is to file an issue at https://github.com/scikit-hep/decaylanguage/issues.
|
|
28
|
-
|
|
29
|
-
If you are proposing a feature:
|
|
30
|
-
|
|
31
|
-
* Explain in detail how it would work.
|
|
32
|
-
* Keep the scope as narrow as possible, to make it easier to implement.
|
|
33
|
-
* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
|
|
34
|
-
|
|
35
|
-
Development
|
|
36
|
-
===========
|
|
37
|
-
|
|
38
|
-
To set up `decaylanguage` for local development:
|
|
39
|
-
|
|
40
|
-
1. Fork `decaylanguage <https://github.com/scikit-hep/decaylanguage>`_
|
|
41
|
-
(look for the "Fork" button).
|
|
42
|
-
2. Clone your fork locally::
|
|
43
|
-
|
|
44
|
-
git clone git@github.com:your_name_here/decaylanguage.git
|
|
45
|
-
|
|
46
|
-
3. Create a branch for local development::
|
|
47
|
-
|
|
48
|
-
git checkout -b name-of-your-bugfix-or-feature
|
|
49
|
-
|
|
50
|
-
Now you can make your changes locally.
|
|
51
|
-
|
|
52
|
-
4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.io/en/latest/install.html>`_ one command::
|
|
53
|
-
|
|
54
|
-
tox
|
|
55
|
-
|
|
56
|
-
5. Commit your changes and push your branch to GitHub::
|
|
57
|
-
|
|
58
|
-
git add .
|
|
59
|
-
git commit -m "Your detailed description of your changes."
|
|
60
|
-
git push origin name-of-your-bugfix-or-feature
|
|
61
|
-
|
|
62
|
-
6. Submit a pull request through the GitHub website.
|
|
63
|
-
|
|
64
|
-
Pull Request Guidelines
|
|
65
|
-
-----------------------
|
|
66
|
-
|
|
67
|
-
If you need some code review or feedback while you're developing the code just make the pull request.
|
|
68
|
-
|
|
69
|
-
For merging, you should:
|
|
70
|
-
|
|
71
|
-
1. Include passing tests (run ``tox``) [1]_.
|
|
72
|
-
2. Update documentation when there's new API, functionality etc.
|
|
73
|
-
3. Add a note to ``CHANGELOG.md`` about the changes.
|
|
74
|
-
4. Add yourself to ``AUTHORS.rst``.
|
|
75
|
-
|
|
76
|
-
.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
|
|
77
|
-
`run the tests <https://travis-ci.org/scikit-hep/decaylanguage/pull_requests>`_ for each change you add in the pull request.
|
|
78
|
-
|
|
79
|
-
It will be slower though ...
|
|
80
|
-
|
|
81
|
-
Tips
|
|
82
|
-
----
|
|
83
|
-
|
|
84
|
-
To run a subset of tests::
|
|
85
|
-
|
|
86
|
-
tox -e envname -- py.test -k test_myfeature
|
|
87
|
-
|
|
88
|
-
To run all the test environments in *parallel* (you need to ``pip install detox``)::
|
|
89
|
-
|
|
90
|
-
detox
|
|
1
|
+
============
|
|
2
|
+
Contributing
|
|
3
|
+
============
|
|
4
|
+
|
|
5
|
+
Contributions are welcome, and they are greatly appreciated! Every
|
|
6
|
+
little bit helps, and credit will always be given.
|
|
7
|
+
|
|
8
|
+
Bug reports
|
|
9
|
+
===========
|
|
10
|
+
|
|
11
|
+
When `reporting a bug <https://github.com/scikit-hep/decaylanguage/issues>`_ please include:
|
|
12
|
+
|
|
13
|
+
* Your operating system name and version.
|
|
14
|
+
* Any details about your local setup that might be helpful in troubleshooting.
|
|
15
|
+
* Detailed steps to reproduce the bug.
|
|
16
|
+
|
|
17
|
+
Documentation improvements
|
|
18
|
+
==========================
|
|
19
|
+
|
|
20
|
+
decaylanguage could always use more documentation, whether as part of the
|
|
21
|
+
official decaylanguage docs, in docstrings, or even on the web in blog posts,
|
|
22
|
+
articles, and such.
|
|
23
|
+
|
|
24
|
+
Feature requests and feedback
|
|
25
|
+
=============================
|
|
26
|
+
|
|
27
|
+
The best way to send feedback is to file an issue at https://github.com/scikit-hep/decaylanguage/issues.
|
|
28
|
+
|
|
29
|
+
If you are proposing a feature:
|
|
30
|
+
|
|
31
|
+
* Explain in detail how it would work.
|
|
32
|
+
* Keep the scope as narrow as possible, to make it easier to implement.
|
|
33
|
+
* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
|
|
34
|
+
|
|
35
|
+
Development
|
|
36
|
+
===========
|
|
37
|
+
|
|
38
|
+
To set up `decaylanguage` for local development:
|
|
39
|
+
|
|
40
|
+
1. Fork `decaylanguage <https://github.com/scikit-hep/decaylanguage>`_
|
|
41
|
+
(look for the "Fork" button).
|
|
42
|
+
2. Clone your fork locally::
|
|
43
|
+
|
|
44
|
+
git clone git@github.com:your_name_here/decaylanguage.git
|
|
45
|
+
|
|
46
|
+
3. Create a branch for local development::
|
|
47
|
+
|
|
48
|
+
git checkout -b name-of-your-bugfix-or-feature
|
|
49
|
+
|
|
50
|
+
Now you can make your changes locally.
|
|
51
|
+
|
|
52
|
+
4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.io/en/latest/install.html>`_ one command::
|
|
53
|
+
|
|
54
|
+
tox
|
|
55
|
+
|
|
56
|
+
5. Commit your changes and push your branch to GitHub::
|
|
57
|
+
|
|
58
|
+
git add .
|
|
59
|
+
git commit -m "Your detailed description of your changes."
|
|
60
|
+
git push origin name-of-your-bugfix-or-feature
|
|
61
|
+
|
|
62
|
+
6. Submit a pull request through the GitHub website.
|
|
63
|
+
|
|
64
|
+
Pull Request Guidelines
|
|
65
|
+
-----------------------
|
|
66
|
+
|
|
67
|
+
If you need some code review or feedback while you're developing the code just make the pull request.
|
|
68
|
+
|
|
69
|
+
For merging, you should:
|
|
70
|
+
|
|
71
|
+
1. Include passing tests (run ``tox``) [1]_.
|
|
72
|
+
2. Update documentation when there's new API, functionality etc.
|
|
73
|
+
3. Add a note to ``CHANGELOG.md`` about the changes.
|
|
74
|
+
4. Add yourself to ``AUTHORS.rst``.
|
|
75
|
+
|
|
76
|
+
.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
|
|
77
|
+
`run the tests <https://travis-ci.org/scikit-hep/decaylanguage/pull_requests>`_ for each change you add in the pull request.
|
|
78
|
+
|
|
79
|
+
It will be slower though ...
|
|
80
|
+
|
|
81
|
+
Tips
|
|
82
|
+
----
|
|
83
|
+
|
|
84
|
+
To run a subset of tests::
|
|
85
|
+
|
|
86
|
+
tox -e envname -- py.test -k test_myfeature
|
|
87
|
+
|
|
88
|
+
To run all the test environments in *parallel* (you need to ``pip install detox``)::
|
|
89
|
+
|
|
90
|
+
detox
|
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
BSD 3-Clause License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2018-2019, Eduardo Rodrigues and Henry Schreiner.
|
|
4
|
-
All rights reserved.
|
|
5
|
-
|
|
6
|
-
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
|
|
7
|
-
conditions are met:
|
|
8
|
-
|
|
9
|
-
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
10
|
-
|
|
11
|
-
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
|
|
12
|
-
disclaimer in the documentation and/or other materials provided with the distribution.
|
|
13
|
-
|
|
14
|
-
* Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
|
|
15
|
-
derived from this software without specific prior written permission.
|
|
16
|
-
|
|
17
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
|
|
18
|
-
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
|
19
|
-
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
20
|
-
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
21
|
-
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
|
|
22
|
-
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
23
|
-
POSSIBILITY OF SUCH DAMAGE.
|
|
1
|
+
BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2018-2019, Eduardo Rodrigues and Henry Schreiner.
|
|
4
|
+
All rights reserved.
|
|
5
|
+
|
|
6
|
+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
|
|
7
|
+
conditions are met:
|
|
8
|
+
|
|
9
|
+
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
10
|
+
|
|
11
|
+
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
|
|
12
|
+
disclaimer in the documentation and/or other materials provided with the distribution.
|
|
13
|
+
|
|
14
|
+
* Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
|
|
15
|
+
derived from this software without specific prior written permission.
|
|
16
|
+
|
|
17
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
|
|
18
|
+
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
|
19
|
+
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
20
|
+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
21
|
+
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
|
|
22
|
+
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
23
|
+
POSSIBILITY OF SUCH DAMAGE.
|
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
graft docs
|
|
2
|
-
graft ci
|
|
3
|
-
graft tests
|
|
4
|
-
graft notebooks
|
|
5
|
-
graft scripts
|
|
6
|
-
graft models
|
|
7
|
-
|
|
8
|
-
prune docs/html
|
|
9
|
-
prune notebooks/.ipynb_checkpoints
|
|
10
|
-
|
|
11
|
-
include .bumpversion.cfg
|
|
12
|
-
include .coveragerc
|
|
13
|
-
include .cookiecutterrc
|
|
14
|
-
include .editorconfig
|
|
15
|
-
|
|
16
|
-
include AUTHORS.rst
|
|
17
|
-
include CHANGELOG.md
|
|
18
|
-
include CONTRIBUTING.rst
|
|
19
|
-
include LICENSE
|
|
20
|
-
include README.md
|
|
21
|
-
include Pipfile
|
|
22
|
-
|
|
23
|
-
include tox.ini .travis.yml .appveyor.yml
|
|
24
|
-
|
|
25
|
-
recursive-include decaylanguage *.py
|
|
26
|
-
recursive-include decaylanguage *.csv
|
|
27
|
-
recursive-include decaylanguage *.txt
|
|
28
|
-
recursive-include decaylanguage *.lark
|
|
29
|
-
|
|
30
|
-
recursive-include images *.pdf
|
|
31
|
-
recursive-include images *.png
|
|
32
|
-
recursive-include images *.svg
|
|
33
|
-
|
|
34
|
-
global-exclude *.py[cod] __pycache__ *.so *.dylib
|
|
1
|
+
graft docs
|
|
2
|
+
graft ci
|
|
3
|
+
graft tests
|
|
4
|
+
graft notebooks
|
|
5
|
+
graft scripts
|
|
6
|
+
graft models
|
|
7
|
+
|
|
8
|
+
prune docs/html
|
|
9
|
+
prune notebooks/.ipynb_checkpoints
|
|
10
|
+
|
|
11
|
+
include .bumpversion.cfg
|
|
12
|
+
include .coveragerc
|
|
13
|
+
include .cookiecutterrc
|
|
14
|
+
include .editorconfig
|
|
15
|
+
|
|
16
|
+
include AUTHORS.rst
|
|
17
|
+
include CHANGELOG.md
|
|
18
|
+
include CONTRIBUTING.rst
|
|
19
|
+
include LICENSE
|
|
20
|
+
include README.md
|
|
21
|
+
include Pipfile
|
|
22
|
+
|
|
23
|
+
include tox.ini .travis.yml .appveyor.yml
|
|
24
|
+
|
|
25
|
+
recursive-include decaylanguage *.py
|
|
26
|
+
recursive-include decaylanguage *.csv
|
|
27
|
+
recursive-include decaylanguage *.txt
|
|
28
|
+
recursive-include decaylanguage *.lark
|
|
29
|
+
|
|
30
|
+
recursive-include images *.pdf
|
|
31
|
+
recursive-include images *.png
|
|
32
|
+
recursive-include images *.svg
|
|
33
|
+
|
|
34
|
+
global-exclude *.py[cod] __pycache__ *.so *.dylib
|