space-dolphin


Namespace-dolphin JSON
Version 1.1.3 PyPI version JSON
download
home_pagehttps://github.com/ajshajib/dolphin
SummaryAutomated pipeline for lens modeling based on lenstronomy
upload_time2025-07-29 22:30:10
maintainerNone
docs_urlNone
authorAnowar J. Shajib
requires_python>=3.9
licenseNone
keywords dolphin lenstronomy
VCS
bugtrack_url
requirements numpy astropy scipy emcee matplotlib lenstronomy schwimmbad corner pyyaml h5py tqdm tensorflow gdown
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. |logo| image:: https://raw.githubusercontent.com/ajshajib/dolphin/efb2673646edd6c2d98963e9f4d08a9104d293c3/logo.png
    :width: 70

|logo| dolphin
==============

.. image:: https://readthedocs.org/projects/dolphin-docs/badge/?version=latest
    :target: https://dolphin-docs.readthedocs.io/latest/
.. image:: https://github.com/ajshajib/dolphin/actions/workflows/ci.yaml/badge.svg?branch=main
    :target: https://github.com/ajshajib/dolphin/actions/workflows/ci.yaml
.. image:: https://codecov.io/gh/ajshajib/dolphin/branch/main/graph/badge.svg?token=WZVXZS9GF1 
    :target: https://app.codecov.io/gh/ajshajib/dolphin/tree/main
    :alt: Codecov
.. image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
    :target: https://github.com/ajshajib/dolphin/blob/main/LICENSE
    :alt: License BSD 3-Clause Badge
.. image:: https://img.shields.io/badge/arXiv-2503.22657-b31b1b?logo=arxiv&logoColor=white
    :target: https://arxiv.org/abs/2503.22657
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.16587211.svg
  :target: https://doi.org/10.5281/zenodo.16587211
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=brightyellow
    :target: https://pre-commit.com/
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
    :target: https://github.com/PyCQA/docformatter
.. image:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg
    :target: https://www.sphinx-doc.org/en/master/usage/index.html

AI-powered automated pipeline for lens modeling, with
`lenstronomy <https://github.com/lenstronomy/lenstronomy>`_ as the modeling engine.

Features
--------

- **AI-automated** forward modeling for large samples of galaxy-scale lenses.
- **Flexible**: supports both fully automated and semi-automated (with user tweaks) modes.
- **Multi-band** lens modeling made simple.
- Supports both **galaxy–galaxy** and **galaxy–quasar** systems.
- Effortless syncing between local machines and **HPCC**.
- |Codecov| **tested!**

.. |Codecov| image:: https://codecov.io/gh/ajshajib/dolphin/branch/main/graph/badge.svg?token=WZVXZS9GF1 
    :target: https://app.codecov.io/gh/ajshajib/dolphin/tree/main

Installation
------------

.. image:: https://img.shields.io/pypi/v/space-dolphin.svg
   :alt: PyPI - Version
   :target: https://pypi.org/project/space-dolphin/


You can install ``dolphin`` using ``pip``. Run the following command:

.. code-block:: bash

    pip install space-dolphin

Alternatively, you can install the latest development version from GitHub as:

.. code-block:: bash

    git clone https://github.com/ajshajib/dolphin.git
    cd dolphin
    pip install .

See the `Quickstart guide <QUICKSTART.rst>`_ for instructions on setting up and running ``dolphin``.

Citation
--------

If you use ``dolphin`` in your research, please cite the ``dolphin`` paper `Shajib et al. (2025) <https://arxiv.org/abs/2503.22657>`_. If you have used the ``"galaxy-quasar"`` fitting recipe, then additionally cite `Shajib et al. (2019) <https://ui.adsabs.harvard.edu/abs/2019MNRAS.483.5649S/abstract>`_, or if you have used the ``"galaxy-galaxy"`` fitting recipe, then additionally cite `Shajib et al. (2021) <https://ui.adsabs.harvard.edu/abs/2021MNRAS.503.2380S/abstract>`_.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ajshajib/dolphin",
    "name": "space-dolphin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "dolphin, lenstronomy",
    "author": "Anowar J. Shajib",
    "author_email": "\"Anowar J. Shajib\" <ajshajib@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/9a/7a/e480420ceff70fa9a689fbe87447fb7f42c017776fafb523ac4b05c13b0c/space_dolphin-1.1.3.tar.gz",
    "platform": null,
    "description": ".. |logo| image:: https://raw.githubusercontent.com/ajshajib/dolphin/efb2673646edd6c2d98963e9f4d08a9104d293c3/logo.png\n    :width: 70\n\n|logo| dolphin\n==============\n\n.. image:: https://readthedocs.org/projects/dolphin-docs/badge/?version=latest\n    :target: https://dolphin-docs.readthedocs.io/latest/\n.. image:: https://github.com/ajshajib/dolphin/actions/workflows/ci.yaml/badge.svg?branch=main\n    :target: https://github.com/ajshajib/dolphin/actions/workflows/ci.yaml\n.. image:: https://codecov.io/gh/ajshajib/dolphin/branch/main/graph/badge.svg?token=WZVXZS9GF1 \n    :target: https://app.codecov.io/gh/ajshajib/dolphin/tree/main\n    :alt: Codecov\n.. image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg\n    :target: https://github.com/ajshajib/dolphin/blob/main/LICENSE\n    :alt: License BSD 3-Clause Badge\n.. image:: https://img.shields.io/badge/arXiv-2503.22657-b31b1b?logo=arxiv&logoColor=white\n    :target: https://arxiv.org/abs/2503.22657\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.16587211.svg\n  :target: https://doi.org/10.5281/zenodo.16587211\n.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=brightyellow\n    :target: https://pre-commit.com/\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg\n    :target: https://github.com/PyCQA/docformatter\n.. image:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg\n    :target: https://www.sphinx-doc.org/en/master/usage/index.html\n\nAI-powered automated pipeline for lens modeling, with\n`lenstronomy <https://github.com/lenstronomy/lenstronomy>`_ as the modeling engine.\n\nFeatures\n--------\n\n- **AI-automated** forward modeling for large samples of galaxy-scale lenses.\n- **Flexible**: supports both fully automated and semi-automated (with user tweaks) modes.\n- **Multi-band** lens modeling made simple.\n- Supports both **galaxy\u2013galaxy** and **galaxy\u2013quasar** systems.\n- Effortless syncing between local machines and **HPCC**.\n- |Codecov| **tested!**\n\n.. |Codecov| image:: https://codecov.io/gh/ajshajib/dolphin/branch/main/graph/badge.svg?token=WZVXZS9GF1 \n    :target: https://app.codecov.io/gh/ajshajib/dolphin/tree/main\n\nInstallation\n------------\n\n.. image:: https://img.shields.io/pypi/v/space-dolphin.svg\n   :alt: PyPI - Version\n   :target: https://pypi.org/project/space-dolphin/\n\n\nYou can install ``dolphin`` using ``pip``. Run the following command:\n\n.. code-block:: bash\n\n    pip install space-dolphin\n\nAlternatively, you can install the latest development version from GitHub as:\n\n.. code-block:: bash\n\n    git clone https://github.com/ajshajib/dolphin.git\n    cd dolphin\n    pip install .\n\nSee the `Quickstart guide <QUICKSTART.rst>`_ for instructions on setting up and running ``dolphin``.\n\nCitation\n--------\n\nIf you use ``dolphin`` in your research, please cite the ``dolphin`` paper `Shajib et al. (2025) <https://arxiv.org/abs/2503.22657>`_. If you have used the ``\"galaxy-quasar\"`` fitting recipe, then additionally cite `Shajib et al. (2019) <https://ui.adsabs.harvard.edu/abs/2019MNRAS.483.5649S/abstract>`_, or if you have used the ``\"galaxy-galaxy\"`` fitting recipe, then additionally cite `Shajib et al. (2021) <https://ui.adsabs.harvard.edu/abs/2021MNRAS.503.2380S/abstract>`_.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Automated pipeline for lens modeling based on lenstronomy",
    "version": "1.1.3",
    "project_urls": {
        "Homepage": "https://github.com/ajshajib/dolphin"
    },
    "split_keywords": [
        "dolphin",
        " lenstronomy"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bcdee11515f6744a3b415c68c4498c1e5247b2005479ff1d689a0c027bf18bff",
                "md5": "395d081feb9482cdb29c0fd9f28ff845",
                "sha256": "92d02517c8afebd0dac3be0d5c5eb3d104e345142950354f6d2937d361762ff5"
            },
            "downloads": -1,
            "filename": "space_dolphin-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "395d081feb9482cdb29c0fd9f28ff845",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 36576,
            "upload_time": "2025-07-29T22:30:09",
            "upload_time_iso_8601": "2025-07-29T22:30:09.240924Z",
            "url": "https://files.pythonhosted.org/packages/bc/de/e11515f6744a3b415c68c4498c1e5247b2005479ff1d689a0c027bf18bff/space_dolphin-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9a7ae480420ceff70fa9a689fbe87447fb7f42c017776fafb523ac4b05c13b0c",
                "md5": "ca5113d2e52edd9346afff66c1bb33d9",
                "sha256": "19e82af33ffaccf383411a4757b26652f699dc1a8834c249892a14d716564d63"
            },
            "downloads": -1,
            "filename": "space_dolphin-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "ca5113d2e52edd9346afff66c1bb33d9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 36916,
            "upload_time": "2025-07-29T22:30:10",
            "upload_time_iso_8601": "2025-07-29T22:30:10.640704Z",
            "url": "https://files.pythonhosted.org/packages/9a/7a/e480420ceff70fa9a689fbe87447fb7f42c017776fafb523ac4b05c13b0c/space_dolphin-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-29 22:30:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ajshajib",
    "github_project": "dolphin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "numpy",
            "specs": [
                [
                    "<",
                    "2"
                ]
            ]
        },
        {
            "name": "astropy",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": [
                [
                    ">=",
                    "0.19.1"
                ]
            ]
        },
        {
            "name": "emcee",
            "specs": [
                [
                    ">=",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": []
        },
        {
            "name": "lenstronomy",
            "specs": []
        },
        {
            "name": "schwimmbad",
            "specs": [
                [
                    ">=",
                    "0.3.2"
                ]
            ]
        },
        {
            "name": "corner",
            "specs": [
                [
                    ">=",
                    "2.2.1"
                ]
            ]
        },
        {
            "name": "pyyaml",
            "specs": []
        },
        {
            "name": "h5py",
            "specs": []
        },
        {
            "name": "tqdm",
            "specs": []
        },
        {
            "name": "tensorflow",
            "specs": []
        },
        {
            "name": "gdown",
            "specs": []
        }
    ],
    "lcname": "space-dolphin"
}
        
Elapsed time: 0.52715s