Skip to content

Commit

Permalink
docs: extend package description in README (#319)
Browse files Browse the repository at this point in the history
* style: remove space between dependency boundaries
  This style works better when listing several boundaries
  • Loading branch information
redeboer authored Sep 20, 2021
1 parent 850afce commit 518562d
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 14 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,12 @@
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort)

TensorWaves is a fitter package that optimizes mathematical models to data
samples. The models can be any mathematical expression that is then converted
to any computational backend. In addition, TensorWaves provides functionality
to generate toy Monte Carlo data samples.
samples. The models can be any _symbolic_ mathematical expression that is then
converted to any computational backend. In addition, TensorWaves provides
functionality to generate toy Monte Carlo data samples. The package is
developed in parallel with [AmpForm](https://github.com/ComPWA/ampform), which
implements physics models, but its 'lambdifying' mechanisms can in principle be
used independently.

All documentation can be found on
[tensorwaves.rtfd.io](https://tensorwaves.readthedocs.io).
Expand Down
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ The decision to use Python only has been further inspired by
TensorWaves is a fitter package that optimizes mathematical models to data
samples. The models can be any mathematical expression (best expressed with
{mod}`sympy`) that is then converted to any computational backend. In addition,
the {mod}`tensorwaves.data` module allows one to generate toy data samples.
the {mod}`tensorwaves.data` module allows one to generate toy data samples. The
package is developed in parallel with {doc}`AmpForm <ampform:index>`, which
implements physics models, but its 'lambdifying' mechanisms can in principle be
used independently.

```{link-button} usage
---
Expand Down
20 changes: 10 additions & 10 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jax =
numba =
numba
scipy =
scipy >= 1
scipy >=1
viz =
graphviz
all =
Expand All @@ -73,9 +73,9 @@ doc =
%(all)s
jupyter
matplotlib
myst-nb >= 0.11 # myst_enable_extensions
myst-nb >=0.11 # myst_enable_extensions
pandas
Sphinx >= 3
Sphinx >=3
sphinx-book-theme
sphinx-copybutton
sphinx-panels
Expand All @@ -86,12 +86,12 @@ test =
%(all)s
pytest
pytest-cov
pytest-mock >= 3.3.0
pytest-mock >=3.3.0
pytest-notebook
pytest-profiling
pytest-xdist
format =
black < 21.8* # https://github.com/ComPWA/tensorwaves/runs/3459570447 https://github.com/tensorflow/tensorflow/issues/51743
black <21.8* # https://github.com/ComPWA/tensorwaves/runs/3459570447 https://github.com/tensorflow/tensorflow/issues/51743
isort
lint =
flake8
Expand All @@ -102,16 +102,16 @@ lint =
flake8-pytest-style
flake8-rst-docstrings
flake8-use-fstring
mypy >= 0.570 # attrs support
mypy >=0.570 # attrs support
pep8-naming
pydocstyle
pylint != 2.11.* # typing-extensions>=3.10.0 conflict
pylint !=2.11.* # typing-extensions>=3.10.0 conflict
sty =
%(all)s # type hints
%(format)s
%(lint)s
%(test)s # for pytest type hints
pre-commit >= 1.4.0
pre-commit >=1.4.0
types-docutils
types-PyYAML
dev =
Expand All @@ -122,9 +122,9 @@ dev =
aquirdturtle_collapsible_headings
jupyterlab
jupyterlab-code-formatter
pip-tools >= 6.1.0 # for extras_require
pip-tools >=6.1.0 # for extras_require
sphinx-autobuild
tox >= 1.9 # for skip_install, use_develop
tox >=1.9 # for skip_install, use_develop

[options.packages.find]
where = src
Expand Down

0 comments on commit 518562d

Please sign in to comment.