Skip to content

Update Python docs #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pineappl_py/pineappl/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
from .pineappl import version as __version__
from . import bin, fk_table, grid, import_only_subgrid, lumi, subgrid
from . import bin, fk_table, grid, import_only_subgrid, channel, subgrid
8 changes: 4 additions & 4 deletions pineappl_py/pineappl/bin.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ class BinRemapper(PyWrapper):

Parameters
----------
normalizations : sequence(float)
list with normalizations
limits : list(tuple(float,float))
all bin limits as a flat list
normalizations : sequence(float)
list with normalizations
limits : list(tuple(float,float))
all bin limits as a flat list
"""

def __init__(self, normalizations, limits):
Expand Down
16 changes: 16 additions & 0 deletions pineappl_py/pineappl/channel.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
from .pineappl import PyChannel
from .utils import PyWrapper


class Channel(PyWrapper):
"""
Python wrapper object to :class:`~pineappl.pineappl.PyChannel`.

Parameters
----------
entry : list(tuple(int,int,float))
sequence describing a channel combination.
"""

def __init__(self, entry):
self._raw = PyChannel(entry)
10 changes: 4 additions & 6 deletions pineappl_py/pineappl/fk_table.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@


class FkTable(PyWrapper):
"""Python wrapper object to interface
:class:`~pineappl.pineappl.PyFkTable`.
"""Python wrapper object to interface :class:`~pineappl.pineappl.PyFkTable`.

Parameters
----------
Expand Down Expand Up @@ -55,13 +54,12 @@ def optimize(self, assumptions="Nf6Ind"):


class FkAssumptions(PyWrapper):
"""Python wrapper object to interface
:class:`~pineappl.pineappl.PyFkAssumptions`.
"""Python wrapper object to interface :class:`~pineappl.pineappl.PyFkAssumptions`.

Parameters
----------
assumption : str
assumption identifier
assumption : str
assumption identifier
"""

def __init__(self, assumption):
Expand Down
Loading