nullpol 0.1.1__tar.gz

nullpol-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Chun-Fung Wong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nullpol-0.1.1/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: nullpol
+Version: 0.1.1
+Summary: A package to perform model-independent polarization test of gravitational-wave signals.
+Author: Thomas Ng, Balázs Cirok
+Author-email: "Isaac C.F. Wong" <chunfung.wong@kuleuven.be>
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.6.0
+Requires-Dist: numpy>=1.24,<2.0
+Requires-Dist: bilby
+Requires-Dist: bilby_pipe>=1.6.0
+Requires-Dist: gwpy
+Requires-Dist: numba
+Requires-Dist: rocket-fft
+Requires-Dist: scipy
+Requires-Dist: ConfigArgParse
+Requires-Dist: pycbc
+Requires-Dist: healpy
+Requires-Dist: cbcflow
+Requires-Dist: asimov>=0.5.8
+Requires-Dist: h5py
+Requires-Dist: pandas
+Requires-Dist: pyspark>=3.0.0 ; extra == "spark"
+Requires-Dist: bandit[toml]==1.8.2 ; extra == "test"
+Requires-Dist: black==25.1.0 ; extra == "test"
+Requires-Dist: check-manifest==0.50 ; extra == "test"
+Requires-Dist: flake8-bugbear==24.12.12 ; extra == "test"
+Requires-Dist: flake8-docstrings ; extra == "test"
+Requires-Dist: flake8-formatter_junit_xml ; extra == "test"
+Requires-Dist: flake8 ; extra == "test"
+Requires-Dist: flake8-pyproject ; extra == "test"
+Requires-Dist: pre-commit==4.1.0 ; extra == "test"
+Requires-Dist: pylint==3.3.4 ; extra == "test"
+Requires-Dist: pylint_junit ; extra == "test"
+Requires-Dist: pytest-cov==6.0.0 ; extra == "test"
+Requires-Dist: pytest-mock<3.14.1 ; extra == "test"
+Requires-Dist: pytest-runner ; extra == "test"
+Requires-Dist: pytest==8.3.4 ; extra == "test"
+Requires-Dist: pytest-github-actions-annotate-failures ; extra == "test"
+Requires-Dist: shellcheck-py==0.10.0.1 ; extra == "test"
+Project-URL: Documentation, https://git.ligo.org/bayesian-null-stream/nullpol/docs
+Project-URL: Source, https://git.ligo.org/bayesian-null-stream/nullpol
+Project-URL: Tracker, https://git.ligo.org/bayesian-null-stream/nullpol/-/issues
+Provides-Extra: spark
+Provides-Extra: test
+
+|pipeline status|
+
+nullpol
+=======
+
+
+Installation
+------------
+
+To install the package, run the following command::
+
+    pip install .
+
+
+.. |pipeline status| image:: https://git.ligo.org/bayesian-null-stream/nullpol/badges/master/pipeline.svg
+   :target: https://git.ligo.org/bayesian-null-stream/nullpol/commits/main
+

nullpol-0.1.1/README.rst

@@ -0,0 +1,16 @@
+|pipeline status|
+
+nullpol
+=======
+
+
+Installation
+------------
+
+To install the package, run the following command::
+
+    pip install .
+
+
+.. |pipeline status| image:: https://git.ligo.org/bayesian-null-stream/nullpol/badges/master/pipeline.svg
+   :target: https://git.ligo.org/bayesian-null-stream/nullpol/commits/main

nullpol-0.1.1/pyproject.toml

@@ -0,0 +1,349 @@
+[build-system]
+requires = ["flit_core >=2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name =  "nullpol"
+description = "A package to perform model-independent polarization test of gravitational-wave signals."
+authors = [{name="Isaac C.F. Wong",email="chunfung.wong@kuleuven.be"},
+           {name="Thomas Ng"},
+           {name="Balázs Cirok"}]
+readme = "README.rst"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+requires-python = ">=3.10"
+dynamic = ["version"]
+dependencies = [
+    "matplotlib>=3.6.0",
+    "numpy>=1.24,<2.0",
+    "bilby",
+    "bilby_pipe>=1.6.0",
+    "gwpy",
+    "numba",
+    "rocket-fft",
+    "scipy",
+    "ConfigArgParse",
+    "pycbc",
+    "healpy",
+    "cbcflow",
+    "asimov>=0.5.8",
+    "h5py",
+    "pandas",
+]
+
+[project.optional-dependencies]
+spark = [
+    "pyspark>=3.0.0"
+]
+test = [
+    "bandit[toml]==1.8.2",
+    "black==25.1.0",
+    "check-manifest==0.50",
+    "flake8-bugbear==24.12.12",
+    "flake8-docstrings",
+    "flake8-formatter_junit_xml",
+    "flake8",
+    "flake8-pyproject",
+    "pre-commit==4.1.0",
+    "pylint==3.3.4",
+    "pylint_junit",
+    "pytest-cov==6.0.0",
+    "pytest-mock<3.14.1",
+    "pytest-runner",
+    "pytest==8.3.4",
+    "pytest-github-actions-annotate-failures",
+    "shellcheck-py==0.10.0.1"
+]
+
+[project.urls]
+Documentation = "https://git.ligo.org/bayesian-null-stream/nullpol/docs"
+Source = "https://git.ligo.org/bayesian-null-stream/nullpol"
+Tracker = "https://git.ligo.org/bayesian-null-stream/nullpol/-/issues"
+
+[tool.flit.module]
+name = "nullpol"
+
+[tool.bandit]
+exclude_dirs = ["build","dist","tests","scripts"]
+number = 4
+recursive = true
+targets = "src"
+
+[tool.black]
+line-length = 120
+fast = true
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+fail_under = 100
+
+[tool.flake8]
+max-line-length = 120
+select = "F,E,W,B,B901,B902,B903"
+exclude = [
+    ".eggs",
+    ".git",
+    ".tox",
+    "nssm",
+    "obj",
+    "out",
+    "packages",
+    "pywin32",
+    "tests",
+    "swagger_client"
+]
+ignore = [
+    "E722",
+    "B001",
+    "W503",
+    "E203"
+]
+
+[tool.pyright]
+include = ["src"]
+exclude = [
+    "**/node_modules",
+    "**/__pycache__",
+]
+venv = "env37"
+
+reportMissingImports = true
+reportMissingTypeStubs = false
+
+pythonVersion = "3.7"
+pythonPlatform = "Linux"
+
+executionEnvironments = [
+  { root = "src" }
+]
+
+[tool.pytest.ini_options]
+addopts = "--cov-report xml:coverage.xml --cov src --cov-fail-under 0 --cov-append -m 'not integration'"
+pythonpath = [
+  "src"
+]
+testpaths = "tests"
+junit_family = "xunit2"
+markers = [
+    "integration: marks as integration test",
+    "notebooks: marks as notebook test",
+    "gpu: marks as gpu test",
+    "spark: marks tests which need Spark",
+    "slow: marks tests as slow",
+    "unit: fast offline tests",
+]
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+envlist = py, integration, spark, all
+
+[testenv]
+commands =
+    pytest -m "not integration and not spark" {posargs}
+
+[testenv:integration]
+commands =
+    pytest -m "integration" {posargs}
+
+[testenv:spark]
+extras = spark
+setenv =
+       PYSPARK_DRIVER_PYTHON = {envpython}
+       PYSPARK_PYTHON = {envpython}
+commands =
+    pytest -m "spark" {posargs}
+
+[testenv:all]
+extras = all
+setenv =
+       PYSPARK_DRIVER_PYTHON = {envpython}
+       PYSPARK_PYTHON = {envpython}
+commands =
+    pytest {posargs}
+"""
+
+[tool.pylint]
+extension-pkg-whitelist= [
+    "numpy",
+    "torch",
+    "cv2",
+    "pyodbc",
+    "pydantic",
+    "ciso8601",
+    "netcdf4",
+    "scipy"
+]
+ignore="CVS"
+ignore-patterns="test.*?py,conftest.py"
+init-hook='import sys; sys.setrecursionlimit(8 * sys.getrecursionlimit())'
+jobs=0
+limit-inference-results=100
+persistent="yes"
+suggestion-mode="yes"
+unsafe-load-any-extension="no"
+
+[tool.pylint.'MESSAGES CONTROL']
+enable="c-extension-no-member"
+
+[tool.pylint.'REPORTS']
+evaluation="10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)"
+output-format="text"
+reports="no"
+score="yes"
+
+[tool.pylint.'REFACTORING']
+max-nested-blocks=5
+never-returning-functions="sys.exit"
+
+[tool.pylint.'BASIC']
+argument-naming-style="snake_case"
+attr-naming-style="snake_case"
+bad-names= [
+    "foo",
+    "bar"
+]
+class-attribute-naming-style="any"
+class-naming-style="PascalCase"
+const-naming-style="UPPER_CASE"
+docstring-min-length=-1
+function-naming-style="snake_case"
+good-names= [
+    "i",
+    "j",
+    "k",
+    "ex",
+    "Run",
+    "_"
+]
+include-naming-hint="yes"
+inlinevar-naming-style="any"
+method-naming-style="snake_case"
+module-naming-style="any"
+no-docstring-rgx="^_"
+property-classes="abc.abstractproperty"
+variable-naming-style="snake_case"
+
+[tool.pylint.'FORMAT']
+ignore-long-lines="^\\s*(# )?.*['\"]?<?https?://\\S+>?"
+indent-after-paren=4
+indent-string='    '
+max-line-length=120
+max-module-lines=1000
+single-line-class-stmt="no"
+single-line-if-stmt="no"
+
+[tool.pylint.'LOGGING']
+logging-format-style="old"
+logging-modules="logging"
+
+[tool.pylint.'MISCELLANEOUS']
+notes= [
+    "FIXME",
+    "XXX",
+    "TODO"
+]
+
+[tool.pylint.'SIMILARITIES']
+ignore-comments="yes"
+ignore-docstrings="yes"
+ignore-imports="yes"
+min-similarity-lines=7
+
+[tool.pylint.'SPELLING']
+max-spelling-suggestions=4
+spelling-store-unknown-words="no"
+
+[tool.pylint.'STRING']
+check-str-concat-over-line-jumps="no"
+
+[tool.pylint.'TYPECHECK']
+contextmanager-decorators="contextlib.contextmanager"
+generated-members="numpy.*,np.*,pyspark.sql.functions,collect_list"
+ignore-mixin-members="yes"
+ignore-none="yes"
+ignore-on-opaque-inference="yes"
+ignored-classes="optparse.Values,thread._local,_thread._local,numpy,torch,swagger_client"
+ignored-modules="numpy,torch,swagger_client,netCDF4,scipy"
+missing-member-hint="yes"
+missing-member-hint-distance=1
+missing-member-max-choices=1
+
+[tool.pylint.'VARIABLES']
+additional-builtins="dbutils"
+allow-global-unused-variables="yes"
+callbacks= [
+    "cb_",
+    "_cb"
+]
+dummy-variables-rgx="_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_"
+ignored-argument-names="_.*|^ignored_|^unused_"
+init-import="no"
+redefining-builtins-modules="six.moves,past.builtins,future.builtins,builtins,io"
+
+[tool.pylint.'CLASSES']
+defining-attr-methods= [
+    "__init__",
+    "__new__",
+    "setUp",
+    "__post_init__"
+]
+exclude-protected= [
+    "_asdict",
+    "_fields",
+    "_replace",
+    "_source",
+    "_make"
+]
+valid-classmethod-first-arg="cls"
+valid-metaclass-classmethod-first-arg="cls"
+
+[tool.pylint.'DESIGN']
+max-args=5
+max-attributes=7
+max-bool-expr=5
+max-branches=12
+max-locals=15
+max-parents=7
+max-public-methods=20
+max-returns=6
+max-statements=50
+min-public-methods=2
+
+[tool.pylint.'IMPORTS']
+allow-wildcard-with-all="no"
+analyse-fallback-blocks="no"
+deprecated-modules="optparse,tkinter.tix"
+
+[tool.pylint.'EXCEPTIONS']
+overgeneral-exceptions= [
+    "BaseException",
+    "Exception"
+]
+
+[project.scripts]
+nullpol_create_injection = "nullpol.tools.create_injection:main"
+nullpol_create_time_frequency_filter_from_sample = "nullpol.tools.create_time_frequency_filter_from_sample:main"
+nullpol_pipe = "nullpol.tools.main:main"
+nullpol_pipe_analysis = "nullpol.tools.data_analysis:main"
+nullpol_pipe_generation = "nullpol.tools.data_generation:main"
+nullpol_pipe_write_default_ini = "nullpol.tools.parser:main"
+nullpol_get_asimov_yaml = "nullpol.tools.get_asimov_yaml:main"
+
+[project.entry-points.'asimov.pipelines']
+nullpol = "nullpol.asimov.asimov:Nullpol"
+
+[project.entry-points.'asimov.hooks.postmonitor']
+tgrflow = 'nullpol.asimov.tgrflow:Collector'
+
+[project.entry-points.'asimov.hooks.applicator']
+tgrflow = 'nullpol.asimov.tgrflow:Applicator'

nullpol-0.1.1/src/nullpol/.gitignore

@@ -0,0 +1 @@
+_version.py

nullpol-0.1.1/src/nullpol/__init__.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from . import (asimov, calibration, clustering, detector, injection,
+               job_creation, likelihood, null_stream, prior, result, source,
+               time_frequency_transform, utils)
+from .utils import logger
+
+__version__ = '0.1.1'
+
+
+def get_version_information() -> str:
+    """Get version information.
+
+    Returns:
+        str: Version information.
+    """
+    return __version__
+
+
+def log_version_information():
+    """Log version information.
+    """
+    logger.info(f"Running nullpol: {__version__}")
+
+
+__all__ = [
+    'asimov',
+    'calibration',
+    'clustering',
+    'detector',
+    'injection',
+    'job_creation',
+    'likelihood',
+    'null_stream',
+    'prior',
+    'result',
+    'source',
+    'time_frequency_transform',
+    'utils',
+    '__version__',
+    'get_version_information',
+    'log_version_information',
+]

nullpol-0.1.1/src/nullpol/asimov/analysis_defaults.yaml

@@ -0,0 +1,56 @@
+kind: configuration
+hooks:
+   postmonitor:
+     tgrflow:
+       library location:
+   applicator:
+     tgrflow:
+       library location:
+data:
+  channels:
+    H1: H1:GDS-CALIB_STRAIN_CLEAN
+    L1: L1:GDS-CALIB_STRAIN_CLEAN
+    V1: V1:Hrec_hoft_16384Hz
+  frame types:
+    H1: H1_HOFT_C00
+    L1: L1_HOFT_C00
+    V1: V1Online
+pipelines:
+  gwdata:
+    scheduler:
+      accounting group: ligo.prod.o4.cbc.testgr.tiger
+      request cpus: 1
+  peconfigurator:
+    scheduler:
+      accounting group: ligo.prod.o4.cbc.testgr.tiger
+      request cpus: 1
+  nullpol:
+    tgr schema section: PolAnalyses
+    quality:
+      state vector:
+        L1: L1:GDS-CALIB_STRAIN_CLEAN
+        H1: H1:GDS-CALIB_STRAIN_CLEAN
+        V1: V1:Hrec_hoft_16384Hz
+    sampler:
+      sampler: dynesty
+      parallel jobs: 4
+    scheduler:
+      accounting group: ligo.prod.o4.cbc.testgr.tiger
+      request cpus: 4
+      request disk: 8
+      request memory: 12
+      scitoken issuer: igwn
+quality:
+  minimum frequency:
+    H1: 20
+    L1: 20
+    V1: 20
+    G1: 20
+    K1: 20
+priors:
+    dec:
+        type: Cosine
+    psi:
+        type: Uniform
+    ra:
+        type: Uniform