{"id":18620517,"url":"https://github.com/simonsobs/pspipe","last_synced_at":"2025-04-11T02:31:12.815Z","repository":{"id":33599749,"uuid":"157757989","full_name":"simonsobs/PSpipe","owner":"simonsobs","description":"Tools for power spectra estimation","archived":false,"fork":false,"pushed_at":"2025-03-24T21:16:13.000Z","size":132547,"stargazers_count":13,"open_issues_count":5,"forks_count":10,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-04T01:03:21.418Z","etag":null,"topics":["cmb","pipeline"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simonsobs.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-15T18:54:50.000Z","updated_at":"2025-03-18T09:45:17.000Z","dependencies_parsed_at":"2023-02-17T18:31:03.583Z","dependency_job_id":"3d046094-6218-4ffe-a769-c349df9d156a","html_url":"https://github.com/simonsobs/PSpipe","commit_stats":{"total_commits":1960,"total_committers":37,"mean_commits":"52.972972972972975","dds":0.5382653061224489,"last_synced_commit":"1734adbfed257279168bb5b1dd73735e53edebc9"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonsobs%2FPSpipe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonsobs%2FPSpipe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonsobs%2FPSpipe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonsobs%2FPSpipe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simonsobs","download_url":"https://codeload.github.com/simonsobs/PSpipe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248329551,"owners_count":21085557,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cmb","pipeline"],"created_at":"2024-11-07T04:06:38.773Z","updated_at":"2025-04-11T02:31:07.805Z","avatar_url":"https://github.com/simonsobs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n.. raw:: html\n\n      \u003cimg src=\"https://github.com/thibautlouis/PSpipe/blob/master/wiki_plot/logo.png\" height=\"400px\"\u003e\n\n.. contents:: **Table of Contents**\n\n\nThe package\n===========\n\n.. image:: https://travis-ci.com/simonsobs/PSpipe.svg?branch=master\n   :target: https://travis-ci.com/simonsobs/PSpipe\n\n``PSpipe`` is a pipeline creator for the analysis of the high resolution maps of the large aperture\ntelescope of the Simons Observatory. It contains tools for estimating power spectra and a\nmulti-frequency likelihood interfaced with the ``cobaya`` MCMC sampler.\n\nThe pipelines are mainly written in python and make use of three different codes,\n\n* ``pspy`` : python library for power spectrum estimation (https://github.com/simonsobs/pspy)\n* ``namaster`` : C library + python wrapper for power spectrum estimation (https://github.com/LSSTDESC/NaMaster)\n* ``mflike`` : mutlifrequency likelihood interfaced with ``cobaya`` (https://github.com/simonsobs/LAT_MFLike)\n\nThe package is licensed under the BSD license.\n\nRequirements\n============\n\n* Python \u003e= 3.8\n* `FFTW \u003chttp://www.fftw.org/\u003e`_: version 3 required\n\nInstalling\n==========\n\nUsing `python/pip`\n------------------\n\nIf the previous requirements are fulfilled, you can install the ``PSpipe`` package with its\ndependencies by doing\n\n.. code:: shell\n\n   $ pip install --user git+https://github.com/simonsobs/PSpipe.git\n\nIf you plan to develop or want to use the different projects, it is better to checkout the latest\nversion by doing\n\n.. code:: shell\n\n    $ git clone https://github.com/simonsobs/PSpipe.git /where/to/clone\n\nThen you can install the ``PSpipe`` library and its dependencies *via*\n\n.. code:: shell\n\n    $ pip install --user /where/to/clone\n\n\nUsing ``docker``\n----------------\n\nGiven the number of requirements, you can use a ``docker`` image already made with the needed\nlibraries and everything compiled. You should first install `docker\n\u003chttps://docs.docker.com/install/\u003e`_ for your operating system.\n\n\nBash installation\n~~~~~~~~~~~~~~~~~~\n\nWe have written a simple bash script to install the ``PSpipe`` docker and to clone the main ``PSpipe`` libraries.\nJust copy the script in a directory where you want to work with pspipe and run\n\n.. code:: shell\n\n   $ ./run_docker.sh\n\n\n\nThis will open a new ``bash`` terminal with a full installation of ``PSpipe``, ``pixell``,\n``NaMaster``, ``pspy``... For instance, you can start the ``ipython`` interpreter and run the following\n``import`` command\n\n.. code:: shell\n\n   $ ipython\n   Python 3.6.9 (default, Nov  7 2019, 10:44:02)\n   Type 'copyright', 'credits' or 'license' for more information\n   IPython 7.11.1 -- An enhanced Interactive Python. Type '?' for help.\n\n   In [1]: import pixell, pymaster, pspy\n\nYou can run the python scripts from the tutorials directory of ``PSpipe``.\n\nWhen you are done with the image, just type ``exit`` and you will go back to your local machine prompt.\n\nRunning ``jupyter`` notebook from docker\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIt is also possible to start a ``jupyter`` server from the ``PSpipe`` image and run it into your web\nbrowser.  Inside the image terminal, you have to start the ``jupyter`` server by typing\n\n.. code:: shell\n\n   $ jupyter notebook --ip 0.0.0.0\n\nFinally open the ``http`` link (something like ``http://127.0.0.1:8888/?token...``) within your web\nbrowser and you should be able to run one of the ``python`` notebook.\n\nSharing data between the ``docker`` container and the host\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nEverything perfomed within the ``/home/pspipe/workspace`` directory will be reflected into\nthe ``/where/to/work_with_pspipe`` on your host machine. You can then share configuration files, source codes, data\nfiles... between the running ``docker`` container and your local machine. Nothing will be lost after\nyou exit from the ``docker`` container.\n\nCryptic ``Killed`` message\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDocker for Mac limits the resource available to 2Gb of RAM by default, This might cause the code to crash unexpectedly with a cryptic ``Killed`` message. It can easily be modified, click on the docker logo (top right of your screen), go in Preferences/Resources and increase the RAM allocated to Docker.\n\nYoutube video\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou are not ready for it:  `youtube \u003chttps://www.youtube.com/watch?v=LtIuM3pxkng\u003e`_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonsobs%2Fpspipe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimonsobs%2Fpspipe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonsobs%2Fpspipe/lists"}