diff --git a/README.md b/README.md index 69b5bfb..0cf1481 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This package provides an easy python interface for interacting with data stored * compiler with C++17 support * pip -If you are installing from source *without a package manager* you will also need to install the project dependencies listed in [pyproject.toml](pyproject.toml). +If you are installing from source *without a package manager* you will also need to install the project dependencies listed in [pyproject.toml](https://github.com/mfmceneaney/hipopy/blob/main/pyproject.toml). ## :package: Installation diff --git a/hipopy/hipopy.py b/hipopy/hipopy.py index 143b001..8c12638 100644 --- a/hipopy/hipopy.py +++ b/hipopy/hipopy.py @@ -530,7 +530,7 @@ def show(self): def showBank(self, bankName): """ Parameters - --------- + ---------- bankName : string, required Description @@ -563,8 +563,7 @@ def readBank(self, bankName): Parameters ---------- bankName : string, required - verbose : boolean, optional - Print out loading message for each event if True + Name of bank to be read Description ----------- @@ -691,6 +690,7 @@ def getInts(self, bankName, item): Parameters ---------- bankName : string, required + Name of bank to be read item : string, required Column name to read in bank @@ -712,6 +712,7 @@ def getFloats(self, bankName, item): Parameters ---------- bankName : string, required + Name of bank to be read item : string, required Column name to read in bank @@ -733,6 +734,7 @@ def getDoubles(self, bankName, item): Parameters ---------- bankName : string, required + Name of bank to be read item : string, required Column name to read in bank @@ -754,6 +756,7 @@ def getShorts(self, bankName, item): Parameters ---------- bankName : string, required + Name of bank to be read item : string, required Column name to read in bank @@ -775,6 +778,7 @@ def getLongs(self, bankName, item): Parameters ---------- bankName : string, required + Name of bank to be read item : string, required Column name to read in bank @@ -796,6 +800,7 @@ def getBytes(self, bankName, item): Parameters ---------- bankName : string, required + Name of bank to be read item : string, required Column name to read in bank diff --git a/poetry.lock b/poetry.lock index 9b197be..2772816 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1369,6 +1369,26 @@ docs = ["sphinxcontrib-websupport"] lint = ["betterproto (==2.0.0b6)", "mypy (==1.15.0)", "pypi-attestations (==0.0.21)", "pyright (==1.1.395)", "pytest (>=8.0)", "ruff (==0.9.9)", "sphinx-lint (>=0.9)", "types-Pillow (==10.2.0.20240822)", "types-Pygments (==2.19.0.20250219)", "types-colorama (==0.4.15.20240311)", "types-defusedxml (==0.7.0.20240218)", "types-docutils (==0.21.0.20241128)", "types-requests (==2.32.0.20241016)", "types-urllib3 (==1.26.25.14)"] test = ["cython (>=3.0)", "defusedxml (>=0.7.1)", "pytest (>=8.0)", "pytest-xdist[psutil] (>=3.4)", "setuptools (>=70.0)", "typing_extensions (>=4.9)"] +[[package]] +name = "sphinx-rtd-theme" +version = "3.0.2" +description = "Read the Docs theme for Sphinx" +optional = false +python-versions = ">=3.8" +groups = ["dev"] +files = [ + {file = "sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl", hash = "sha256:422ccc750c3a3a311de4ae327e82affdaf59eb695ba4936538552f3b00f4ee13"}, + {file = "sphinx_rtd_theme-3.0.2.tar.gz", hash = "sha256:b7457bc25dda723b20b086a670b9953c859eab60a2a03ee8eb2bb23e176e5f85"}, +] + +[package.dependencies] +docutils = ">0.18,<0.22" +sphinx = ">=6,<9" +sphinxcontrib-jquery = ">=4,<5" + +[package.extras] +dev = ["bump2version", "transifex-client", "twine", "wheel"] + [[package]] name = "sphinxcontrib-applehelp" version = "2.0.0" @@ -1420,6 +1440,21 @@ lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] standalone = ["Sphinx (>=5)"] test = ["html5lib", "pytest"] +[[package]] +name = "sphinxcontrib-jquery" +version = "4.1" +description = "Extension to include jQuery on newer Sphinx releases" +optional = false +python-versions = ">=2.7" +groups = ["dev"] +files = [ + {file = "sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"}, + {file = "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"}, +] + +[package.dependencies] +Sphinx = ">=1.8" + [[package]] name = "sphinxcontrib-jsmath" version = "1.0.1" @@ -1589,4 +1624,4 @@ type = ["pytest-mypy"] [metadata] lock-version = "2.1" python-versions = ">=3.9.0" -content-hash = "ec235d7f9eff670d21bb10a9bc725635e5fa497bf19aeaa393f752d8fc7af0b9" +content-hash = "5e5fc7ed77885bc0a3770565319ac8f7691a660521e40f9228e5b81e3ba6419e" diff --git a/pyproject.toml b/pyproject.toml index 2a6deb1..e9751bb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,6 +17,7 @@ black = ">=25.9.0" pylint = ">=3.3.8" pytest = ">=5.2" myst_parser = ">=3.0.0" +sphinx-rtd-theme = ">=2.0.0" dill = "^0.4.0" [build-system] diff --git a/requirements.txt b/requirements.txt index d177159..0cfd56e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -awkward >= 1.3.0 -numpy >= 1.19.2 -hipopybind >= 1.1.3 +numpy >= 2.0.0 +hipopybind >= 2.0.1 sphinx-rtd-theme >= 2.0.0 +myst_parser >= 3.0.0