plima 0.1.1__tar.gz

plima-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: "23 1 * * 0"
+  workflow_dispatch:
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv with Python 3.12
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.8.22"
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run Ruff
+        run: uv run tox -e lint -- --output-format github
+
+  testing:
+    needs: linting
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv with Python ${{ matrix.python-version }}
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.8.22"
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run tests
+        run: uv run tox -m test
+
+  finalise:
+    runs-on: ubuntu-latest
+    needs: [linting, testing]
+
+    steps:
+      - name: Finalise
+        run: echo "All done"

plima-0.1.1/.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: Deploy Sphinx Documentation
+
+on:
+  workflow_run:
+    workflows:
+      - CI
+    branches:
+      - main
+    types:
+      - completed
+
+  workflow_dispatch:
+
+jobs:
+  publish_sphinx_docs:
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.8.22"
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        run: uv sync --extra docs --extra plot --extra dev
+
+      - name: Build release docs
+        run: uv run tox -e docs-releases
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html
+          force_orphan: true

plima-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: "Publish new versions of PLIMA to PyPI"
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install Python 3.13
+        run: uv python install 3.13
+
+      - name: Build
+        run: uv build --no-sources
+
+      - name: Publish
+        run: uv publish

plima-0.1.1/.gitignore

@@ -0,0 +1,51 @@
+# Bytecode and caches
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Virtual environments
+.venv/
+venv/
+env/
+.tox/
+.nox/
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+*.egg
+pip-wheel-metadata/
+
+# Generated version file
+src/plima/_version.py
+
+# Sphinx docs builds
+docs/_build/
+docs/api/generated/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDE files
+.vscode/
+.idea/
+
+# Local env files
+.env
+.env.*
+
+# uv
+uv.lock

plima-0.1.1/CITATION.cff

@@ -0,0 +1,14 @@
+cff-version: 0.1.0
+message: "If you use PLIMA, please cite it as below."
+title: "PLIMA: Python Library for Intrinsic alignment Models and Amplitudes"
+type: software
+version: "0.1.0"
+
+authors:
+  - given-names: "Nikolina"
+    family-names: "Šarčević"
+    email: "nikolina.sarcevic@gmail.com"
+    orcid: "0000-0001-7301-6415"
+
+license: "MIT"
+repository-code: "https://github.com/cosmology-kit/plima"

plima-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nikolina Šarčević
+
+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.

plima-0.1.1/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: plima
+Version: 0.1.1
+Summary: Intrinsic alignment modeling tools for cosmology.
+Author-email: Nikolina Šarčević <nikolina.sarcevic@gmail.com>
+License-Expression: MIT
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.23
+Requires-Dist: scipy
+Requires-Dist: py-lfkit
+Requires-Dist: pybinny
+Requires-Dist: pyccl
+Provides-Extra: plot
+Requires-Dist: matplotlib; extra == "plot"
+Requires-Dist: cmasher; extra == "plot"
+Provides-Extra: docs
+Requires-Dist: sphinx<9; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx-multiversion; extra == "docs"
+Requires-Dist: matplotlib; extra == "docs"
+Requires-Dist: cmasher; extra == "docs"
+Requires-Dist: tox; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: pytest-cov>=4; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: tox>=4.22; extra == "dev"
+Dynamic: license-file
+
+# plima
+
+[![CI](https://img.shields.io/github/actions/workflow/status/cosmology-kit/plima/ci.yml?branch=main&label=CI&color=3b9ab2&style=flat-square)](https://github.com/cosmology-kit/plima/actions/workflows/ci.yml)
+[![Docs](https://img.shields.io/badge/docs-main-3b9ab2?style=flat-square)](https://cosmology-kit.github.io/plima/main/)
+[![License](https://img.shields.io/badge/license-MIT-3b9ab2?style=flat-square)](LICENSE)
+
+**PLIMA** is the **Python Library for Intrinsic alignment Models and Amplitudes**.
+
+PLIMA provides simple tools for working with intrinsic alignment models in cosmology.
+It includes model level amplitude functions and [CCL](https://ccl.readthedocs.io/en/latest/index.html) 
+backend helpers for building intrinsic alignment inputs used in weak lensing analyses.
+
+## Models
+
+PLIMA currently includes:
+
+* LA
+* NLA
+* TATT
+* halo model IA
+
+## Installation
+
+For development, clone the repository and install it in editable mode:
+
+```bash
+git clone https://github.com/cosmology-kit/plima.git
+cd plima
+pip install -e ".[dev]"
+```
+
+
+The development documentation is available at:
+
+https://cosmology-kit.github.io/plima/main/
+
+## Citation
+
+If you use PLIMA in your research, please cite it.
+
+```bibtex
+@software{sarcevic2026plima,
+  title   = {PLIMA: Python Library for Intrinsic alignment Models and Amplitudes},
+  author  = {Šarčević, Nikolina},
+  year    = {2026},
+  version = {0.1.0},
+  url     = {https://github.com/cosmology-kit/plima}
+}
+```
+
+## License
+
+MIT License © 2026 Nikolina Šarčević and contributors.

plima-0.1.1/README.md

@@ -0,0 +1,53 @@
+# plima
+
+[![CI](https://img.shields.io/github/actions/workflow/status/cosmology-kit/plima/ci.yml?branch=main&label=CI&color=3b9ab2&style=flat-square)](https://github.com/cosmology-kit/plima/actions/workflows/ci.yml)
+[![Docs](https://img.shields.io/badge/docs-main-3b9ab2?style=flat-square)](https://cosmology-kit.github.io/plima/main/)
+[![License](https://img.shields.io/badge/license-MIT-3b9ab2?style=flat-square)](LICENSE)
+
+**PLIMA** is the **Python Library for Intrinsic alignment Models and Amplitudes**.
+
+PLIMA provides simple tools for working with intrinsic alignment models in cosmology.
+It includes model level amplitude functions and [CCL](https://ccl.readthedocs.io/en/latest/index.html) 
+backend helpers for building intrinsic alignment inputs used in weak lensing analyses.
+
+## Models
+
+PLIMA currently includes:
+
+* LA
+* NLA
+* TATT
+* halo model IA
+
+## Installation
+
+For development, clone the repository and install it in editable mode:
+
+```bash
+git clone https://github.com/cosmology-kit/plima.git
+cd plima
+pip install -e ".[dev]"
+```
+
+
+The development documentation is available at:
+
+https://cosmology-kit.github.io/plima/main/
+
+## Citation
+
+If you use PLIMA in your research, please cite it.
+
+```bibtex
+@software{sarcevic2026plima,
+  title   = {PLIMA: Python Library for Intrinsic alignment Models and Amplitudes},
+  author  = {Šarčević, Nikolina},
+  year    = {2026},
+  version = {0.1.0},
+  url     = {https://github.com/cosmology-kit/plima}
+}
+```
+
+## License
+
+MIT License © 2026 Nikolina Šarčević and contributors.

plima-0.1.1/docs/_build/html/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="refresh" content="0; url=main/" />
+    <title>Redirecting...</title>
+  </head>
+  <body>
+    <p>Redirecting to <a href="main/">main</a>.</p>
+  </body>
+</html>

plima-0.1.1/docs/_templates/pages_redirect.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="refresh" content="0; url=main/" />
+    <title>Redirecting...</title>
+  </head>
+  <body>
+    <p>Redirecting to <a href="main/">main</a>.</p>
+  </body>
+</html>

plima-0.1.1/docs/api/index.rst

@@ -0,0 +1,8 @@
+API Reference
+=============
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   plima

plima-0.1.1/docs/conf.py

@@ -0,0 +1,150 @@
+# Configuration file for the Sphinx documentation builder.
+
+from __future__ import annotations
+
+import os
+import sys
+import warnings
+
+import matplotlib
+
+matplotlib.use("Agg")
+
+# -----------------------------------------------------------------------------
+# Ensure src/ layout imports work
+# -----------------------------------------------------------------------------
+sys.path.insert(0, os.path.abspath("../src"))
+
+warnings.filterwarnings(
+    "ignore",
+    category=SyntaxWarning,
+    module=r"colorspacious\.comparison",
+)
+
+# -----------------------------------------------------------------------------
+# Project information
+# -----------------------------------------------------------------------------
+project = "PLIMA"
+author = "Nikolina Šarčević"
+copyright = "2026, Nikolina Šarčević"
+
+# Remove default "documentation" suffix in browser title
+html_title = "PLIMA Documentation"
+
+# -----------------------------------------------------------------------------
+# General configuration
+# -----------------------------------------------------------------------------
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.doctest",
+    "sphinx.ext.githubpages",
+    "matplotlib.sphinxext.plot_directive",
+    "sphinx_design",
+    "sphinx_multiversion",
+    "sphinx.ext.mathjax",
+    "sphinx_copybutton",
+]
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -----------------------------------------------------------------------------
+# Autodoc / autosummary
+# -----------------------------------------------------------------------------
+autosummary_generate = True
+autodoc_typehints = "description"
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+
+autoclass_content = "both"
+
+autodoc_default_options = {
+    "members": True,
+}
+
+# -----------------------------------------------------------------------------
+# Doctest configuration
+# -----------------------------------------------------------------------------
+doctest_global_setup = r"""
+import numpy as np
+np.set_printoptions(precision=12, suppress=True)
+"""
+
+# -----------------------------------------------------------------------------
+# HTML output
+# -----------------------------------------------------------------------------
+html_baseurl = "https://cosmology-kit.github.io/plima/"
+
+html_theme = "furo"
+html_permalinks_icon = "<span>#</span>"
+
+html_static_path = ["_static"]
+
+html_theme_options = {
+    "source_repository": "https://github.com/cosmology-kit/plima/",
+    "source_branch": "main",
+    "source_directory": "docs/",
+    "light_css_variables": {
+        "color-brand-primary": "#3B9AB2",
+        "color-brand-content": "#3B9AB2",
+        "color-link": "#3B9AB2",
+        "color-link--hover": "#F21A00",
+        "color-link--visited": "#3B9AB2",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#3B9AB2",
+        "color-brand-content": "#3B9AB2",
+        "color-link": "#3B9AB2",
+        "color-link--hover": "#F21A00",
+        "color-link--visited": "#3B9AB2",
+    },
+}
+
+html_css_files = [
+    "custom.css",
+]
+
+# -----------------------------------------------------------------------------
+# Matplotlib plot directive
+# -----------------------------------------------------------------------------
+plot_html_show_source_link = False
+
+plot_formats = [("png", 300)]
+
+plot_rcparams = {
+    "figure.dpi": 150,
+    "savefig.dpi": 150,
+    "xtick.direction": "in",
+    "ytick.direction": "in",
+    "xtick.top": True,
+    "ytick.right": True,
+    "font.size": 15,
+    "axes.labelsize": 15,
+    "axes.titlesize": 17,
+    "legend.fontsize": 15,
+    "xtick.labelsize": 13,
+    "ytick.labelsize": 13,
+    "axes.linewidth": 2,
+    "xtick.major.width": 1.2,
+    "ytick.major.width": 1.2,
+}
+
+# -----------------------------------------------------------------------------
+# Sphinx multiversion
+# -----------------------------------------------------------------------------
+smv_tag_whitelist = r"^v\d+\.\d+\.\d+$"
+smv_branch_whitelist = r"^main$"
+smv_remote_whitelist = r"^origin$"
+smv_released_pattern = r"^refs/tags/v\d+\.\d+\.\d+$"
+smv_outputdir_format = "{ref.name}"
+smv_site_url = "https://cosmology-kit.github.io/plima/"
+
+# -----------------------------------------------------------------------------
+# Copybutton configuration
+# -----------------------------------------------------------------------------
+copybutton_prompt_text = r">>> |\.\.\. "
+copybutton_prompt_is_regexp = True
+copybutton_copy_empty_lines = False

plima-0.1.1/docs/index.rst

@@ -0,0 +1,5 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api/index