| Name | psinspect JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | Power spectra inspector for the SO LAT experiment |
| upload_time | 2023-11-24 09:49:20 |
| maintainer | |
| docs_url | None |
| author | Simons Observatory Collaboration Power Spectrum Task Force |
| requires_python | >=3.8.0 |
| license | BSD License Copyright (c) 2020, Simons Observatory Collaboration Analysis Library Task Force All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
visualisation
pipeline
cosmology
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. image:: https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/solid/user-secret.svg
:target: https://github.com/xgarrido/psinspect
:width: 110
:height: 110
:align: left
``psinspect`` is a visual application to check for CMB power spectra and covariance matrices
calculations through `PSpipe <https://github.com/simonsobs/PSpipe>`_.
.. image:: https://img.shields.io/pypi/v/psinspect.svg?style=flat
:target: https://pypi.python.org/pypi/psinspect/
.. image:: https://img.shields.io/github/actions/workflow/status/xgarrido/psinspect/testing.yml?branch=main
:target: https://github.com/xgarrido/psinspect/actions?query=workflow%3ATesting
.. image:: https://codecov.io/gh/xgarrido/psinspect/branch/main/graph/badge.svg?token=HHAJ7NQ5CE
:target: https://codecov.io/gh/xgarrido/psinspect
.. image:: https://results.pre-commit.ci/badge/github/xgarrido/psinspect/main.svg
:target: https://results.pre-commit.ci/latest/github/xgarrido/psinspect/main
:alt: pre-commit.ci status
.. image:: https://img.shields.io/badge/license-BSD-yellow
:target: https://github.com/xgarrido/psinspect/blob/master/LICENSE
..
.. image:: https://readthedocs.org/projects/pspy/badge/?version=latest
:target: https://pspy.readthedocs.io/en/latest/?badge=latest
.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/simonsobs/pspy/master?filepath=notebooks/%2Findex.ipynb
|
Installing
----------
The easiest way is to get the PyPI version with
.. code:: shell
pip install psinspect [--user]
You can test if everything has been properly installed with
.. code:: shell
psinspect
If everything goes fine, no errors will occur. Otherwise, you can report your problem on the `Issues tracker <https://github.com/xgarrido/psinspect/issues>`_.
If you plan to develop/change something inside ``psinspect``, it is better to checkout the latest version by doing
.. code:: shell
git clone https://github.com/xgarrido/psinspect.git /where/to/clone
Then you can install the ``psinspect`` library and its dependencies *via*
.. code:: shell
pip install -e /where/to/clone
The ``-e`` option allow the developer to make changes within the ``psinspect`` directory without having
to reinstall at every changes.
Using ``psinspect`` at NERSC
----------------------------
At NERSC, after having set ``python`` with ``module load python``, you can follow the same
installation process and everything will be installed in your local home. Then you can go to `NERSC
Jupyter Hub <https://jupyter.nersc.gov>`_ and start a notebook with the following minimal set of
commands
.. code:: python
from psinspect import App
my_app = App()
my_app.initialize()
my_app.start()
Another (smarter) way is to encapsulate the whole installation stuff within a ``python`` virtual
env. to avoid conflicts with your existing installation. To do so you can follow these command lines
.. code:: shell
module load python
python -m venv /where/to/install/your/env
source /where/to/install/your/env/bin/activate
python -m pip install ipykernel
python -m ipykernel install --user --name=psinspect
This will install a new kernel named ``psinspect`` that you can choose when you will create a new
notebook in `NERSC Jupyter Hub <https://jupyter.nersc.gov>`_. Copy-paste the above ``python`` code
and execute the cell.
The code is part of `PSpipe <https://github.com/simonsobs/PSpipe>`_ the Simons Observatory power spectrum pipeline.
Raw data
{
"_id": null,
"home_page": "",
"name": "psinspect",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": "Xavier Garrido <xavier.garrido@ijclab.in2p3.fr>",
"keywords": "visualisation,pipeline,cosmology",
"author": "Simons Observatory Collaboration Power Spectrum Task Force",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ec/33/22187ea24e5e5b4c262a13deeb75e2c8f096cf1dbc51f8111205eef4d42b/psinspect-0.1.1.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/solid/user-secret.svg\n :target: https://github.com/xgarrido/psinspect\n :width: 110\n :height: 110\n :align: left\n\n``psinspect`` is a visual application to check for CMB power spectra and covariance matrices\ncalculations through `PSpipe <https://github.com/simonsobs/PSpipe>`_.\n\n.. image:: https://img.shields.io/pypi/v/psinspect.svg?style=flat\n :target: https://pypi.python.org/pypi/psinspect/\n.. image:: https://img.shields.io/github/actions/workflow/status/xgarrido/psinspect/testing.yml?branch=main\n :target: https://github.com/xgarrido/psinspect/actions?query=workflow%3ATesting\n.. image:: https://codecov.io/gh/xgarrido/psinspect/branch/main/graph/badge.svg?token=HHAJ7NQ5CE\n :target: https://codecov.io/gh/xgarrido/psinspect\n.. image:: https://results.pre-commit.ci/badge/github/xgarrido/psinspect/main.svg\n :target: https://results.pre-commit.ci/latest/github/xgarrido/psinspect/main\n :alt: pre-commit.ci status\n.. image:: https://img.shields.io/badge/license-BSD-yellow\n :target: https://github.com/xgarrido/psinspect/blob/master/LICENSE\n\n..\n .. image:: https://readthedocs.org/projects/pspy/badge/?version=latest\n :target: https://pspy.readthedocs.io/en/latest/?badge=latest\n .. image:: https://mybinder.org/badge_logo.svg\n :target: https://mybinder.org/v2/gh/simonsobs/pspy/master?filepath=notebooks/%2Findex.ipynb\n\n|\n\nInstalling\n----------\n\nThe easiest way is to get the PyPI version with\n\n.. code:: shell\n\n pip install psinspect [--user]\n\nYou can test if everything has been properly installed with\n\n.. code:: shell\n\n psinspect\n\nIf everything goes fine, no errors will occur. Otherwise, you can report your problem on the `Issues tracker <https://github.com/xgarrido/psinspect/issues>`_.\n\nIf you plan to develop/change something inside ``psinspect``, it is better to checkout the latest version by doing\n\n.. code:: shell\n\n git clone https://github.com/xgarrido/psinspect.git /where/to/clone\n\nThen you can install the ``psinspect`` library and its dependencies *via*\n\n.. code:: shell\n\n pip install -e /where/to/clone\n\nThe ``-e`` option allow the developer to make changes within the ``psinspect`` directory without having\nto reinstall at every changes.\n\nUsing ``psinspect`` at NERSC\n----------------------------\n\nAt NERSC, after having set ``python`` with ``module load python``, you can follow the same\ninstallation process and everything will be installed in your local home. Then you can go to `NERSC\nJupyter Hub <https://jupyter.nersc.gov>`_ and start a notebook with the following minimal set of\ncommands\n\n.. code:: python\n\n from psinspect import App\n my_app = App()\n my_app.initialize()\n my_app.start()\n\nAnother (smarter) way is to encapsulate the whole installation stuff within a ``python`` virtual\nenv. to avoid conflicts with your existing installation. To do so you can follow these command lines\n\n.. code:: shell\n\n module load python\n python -m venv /where/to/install/your/env\n source /where/to/install/your/env/bin/activate\n python -m pip install ipykernel\n python -m ipykernel install --user --name=psinspect\n\nThis will install a new kernel named ``psinspect`` that you can choose when you will create a new\nnotebook in `NERSC Jupyter Hub <https://jupyter.nersc.gov>`_. Copy-paste the above ``python`` code\nand execute the cell.\n\n\nThe code is part of `PSpipe <https://github.com/simonsobs/PSpipe>`_ the Simons Observatory power spectrum pipeline.\n",
"bugtrack_url": null,
"license": " BSD License Copyright (c) 2020, Simons Observatory Collaboration Analysis Library Task Force All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Power spectra inspector for the SO LAT experiment",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://psinspect.readthedocs.io",
"Homepage": "https://github.com/xgarrido/psinspect",
"Licensing": "https://github.com/xgarrido/psinspect/blob/master/LICENCE",
"Source": "https://github.com/xgarrido/psinspect",
"Tracker": "https://github.com/xgarrido/psinspect/issues"
},
"split_keywords": [
"visualisation",
"pipeline",
"cosmology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b3857485a516247fa1eaf66ec2a5d7672f955ad93bc9e6ce4033a60c2b2e225",
"md5": "5bd80aa6b038389b9edfb3b165c6d3ed",
"sha256": "906a662fb0a2f749198856d5ede7116c81a5fef505abaa23f2b41561dc4d84ee"
},
"downloads": -1,
"filename": "psinspect-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5bd80aa6b038389b9edfb3b165c6d3ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 21439,
"upload_time": "2023-11-24T09:49:18",
"upload_time_iso_8601": "2023-11-24T09:49:18.424935Z",
"url": "https://files.pythonhosted.org/packages/7b/38/57485a516247fa1eaf66ec2a5d7672f955ad93bc9e6ce4033a60c2b2e225/psinspect-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec3322187ea24e5e5b4c262a13deeb75e2c8f096cf1dbc51f8111205eef4d42b",
"md5": "e70a585c7a463880a1480831548528ca",
"sha256": "b4621a866e9ebcf5537154bb205e95749cef8f00ea521a6de98c6af6621188a3"
},
"downloads": -1,
"filename": "psinspect-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e70a585c7a463880a1480831548528ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 22676,
"upload_time": "2023-11-24T09:49:20",
"upload_time_iso_8601": "2023-11-24T09:49:20.098066Z",
"url": "https://files.pythonhosted.org/packages/ec/33/22187ea24e5e5b4c262a13deeb75e2c8f096cf1dbc51f8111205eef4d42b/psinspect-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-24 09:49:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xgarrido",
"github_project": "psinspect",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "psinspect"
}
