| Name | lsst-rsp JSON |
| Version |
0.5.2
JSON |
| download |
| home_page | None |
| Summary | Utility functions for the Rubin Science Platform |
| upload_time | 2024-04-22 23:48:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2021-2024 Association of Universities for Research in Astronomy, Inc. (AURA) 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. |
| keywords |
rubin
lsst
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# lsst-rsp
This Python package provides utility functions for the [Rubin Science Platform](https://rsp.lsst.io/), primarily for use within the Notebook Aspect.
These utility functions are documented in the [Notebook aspect documentation](https://rsp.lsst.io/guides/notebooks/index.html) for the Rubin Science Platform.
## Installation
The package can be installed from PyPI:
```sh
pip install lsst-rsp
```
However, most functionality of lsst-rsp is only useful inside a Rubin Science Platform JupyterLab container.
This package is pre-installed in the standard containers.
## Development
The best way to start contributing to lsst-rsp is by cloning this repository, creating a virtual environment, and running the `make init` command:
```sh
git clone https://github.com/lsst-sqre/lsst-rsp.git
cd lsst-rsp
make init
```
You can run tests with [tox](https://tox.wiki/en/latest/):
```sh
tox run
```
To learn more about the individual environments:
```sh
tox list
```
### Developing on the RSP
The `LSST` kernel in the RSP `sciplat-lab` image already has a release version of `lsst-rsp` included.
If you want to use a development version, you must first create a virtualenv, install the necessary packages, and then create a JupyterLab kernel pointing to it.
In a terminal session, run the following commands:
```bash
VENV="lsst_rsp"
mkdir -p ${HOME}/venvs
python -m venv ${HOME}/venvs/${VENV}
. ${HOME}/venvs/${VENV}/bin/activate
mkdir -p ${HOME}/src
cd ${HOME}/src
git clone https://github.com/lsst-sqre/lsst-rsp
# or git clone git@github.com:lsst-sqre/lsst-rsp.git if you prefer
cd lsst-rsp
make init
pip install ipykernel
python -m ipykernel install --user --name=${VENV}
```
Now you will need to shut down your lab and restart it in order to pick up the new lsst-rsp installation.
Once you're in your new container, you will notice that you have a new kernel named `lsst_rsp`.
Now you have an editable version installed in your custom kernel, and you can run all the usual tox environments.
If you start a notebook with your custom kernel, you can see the development version with:
```python
import lsst.rsp
lsst.rsp.__version__
```
You will still need to restart the kernel to pick up changes you make to your copy of `lsst_rsp`.
### Uninstalling a development version from the RSP
In a terminal window, run the following:
```bash
. $HOME/venvs/lsst_rsp/bin/activate
jupyter kernelspec uninstall lsst_rsp
```
Respond `y` and then `deactivate` to the resulting prompts.
Shut down and restart your notebook as before.
When you come back in, in a terminal window, run:
```bash
rm -rf $HOME/venvs/lsst_rsp
```
You cannot remove the virtualenv directory until you have restarted the JupyterLab container, since otherwise JupyterLab will be holding some files open for the running kernel.
Raw data
{
"_id": null,
"home_page": null,
"name": "lsst-rsp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "rubin, lsst",
"author": null,
"author_email": "\"Association of Universities for Research in Astronomy, Inc. (AURA)\" <sqre-admin@lists.lsst.org>",
"download_url": "https://files.pythonhosted.org/packages/a4/34/1918eb44184bcfae9a26d6174a1edf06b17651011195d6f0daafd2fac3ba/lsst_rsp-0.5.2.tar.gz",
"platform": null,
"description": "# lsst-rsp\n\nThis Python package provides utility functions for the [Rubin Science Platform](https://rsp.lsst.io/), primarily for use within the Notebook Aspect.\nThese utility functions are documented in the [Notebook aspect documentation](https://rsp.lsst.io/guides/notebooks/index.html) for the Rubin Science Platform.\n\n## Installation\n\nThe package can be installed from PyPI:\n\n```sh\npip install lsst-rsp\n```\n\nHowever, most functionality of lsst-rsp is only useful inside a Rubin Science Platform JupyterLab container.\nThis package is pre-installed in the standard containers.\n\n## Development\n\nThe best way to start contributing to lsst-rsp is by cloning this repository, creating a virtual environment, and running the `make init` command:\n\n```sh\ngit clone https://github.com/lsst-sqre/lsst-rsp.git\ncd lsst-rsp\nmake init\n```\n\nYou can run tests with [tox](https://tox.wiki/en/latest/):\n\n```sh\ntox run\n```\n\nTo learn more about the individual environments:\n\n```sh\ntox list\n```\n\n### Developing on the RSP\n\nThe `LSST` kernel in the RSP `sciplat-lab` image already has a release version of `lsst-rsp` included.\nIf you want to use a development version, you must first create a virtualenv, install the necessary packages, and then create a JupyterLab kernel pointing to it.\n\nIn a terminal session, run the following commands:\n\n```bash\nVENV=\"lsst_rsp\"\nmkdir -p ${HOME}/venvs\npython -m venv ${HOME}/venvs/${VENV}\n. ${HOME}/venvs/${VENV}/bin/activate\nmkdir -p ${HOME}/src\ncd ${HOME}/src\ngit clone https://github.com/lsst-sqre/lsst-rsp\n# or git clone git@github.com:lsst-sqre/lsst-rsp.git if you prefer\ncd lsst-rsp\nmake init\npip install ipykernel\npython -m ipykernel install --user --name=${VENV}\n```\n\nNow you will need to shut down your lab and restart it in order to pick up the new lsst-rsp installation.\n\nOnce you're in your new container, you will notice that you have a new kernel named `lsst_rsp`.\nNow you have an editable version installed in your custom kernel, and you can run all the usual tox environments.\n\nIf you start a notebook with your custom kernel, you can see the development version with:\n\n```python\nimport lsst.rsp\n\nlsst.rsp.__version__\n```\n\nYou will still need to restart the kernel to pick up changes you make to your copy of `lsst_rsp`.\n\n### Uninstalling a development version from the RSP\n\nIn a terminal window, run the following:\n\n```bash\n. $HOME/venvs/lsst_rsp/bin/activate\njupyter kernelspec uninstall lsst_rsp\n```\n\nRespond `y` and then `deactivate` to the resulting prompts.\n\nShut down and restart your notebook as before.\nWhen you come back in, in a terminal window, run:\n\n```bash\nrm -rf $HOME/venvs/lsst_rsp\n```\n\nYou cannot remove the virtualenv directory until you have restarted the JupyterLab container, since otherwise JupyterLab will be holding some files open for the running kernel.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021-2024 Association of Universities for Research in Astronomy, Inc. (AURA) 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. ",
"summary": "Utility functions for the Rubin Science Platform",
"version": "0.5.2",
"project_urls": {
"Homepage": "https://rsp.lsst.io/",
"Source": "https://github.com/lsst-sqre/lsst-rsp"
},
"split_keywords": [
"rubin",
" lsst"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55c6242485a4fc8cd3afa6f12bc2c3b670390d8ef62d5a46b50f6b758ddec40d",
"md5": "9952779b6d705c34dc31242ae9304c30",
"sha256": "fd93bf2195b3b0c9790b2119e4451b8278a3f0092697a2238e39d288cd55e2c4"
},
"downloads": -1,
"filename": "lsst_rsp-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9952779b6d705c34dc31242ae9304c30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 24818,
"upload_time": "2024-04-22T23:48:05",
"upload_time_iso_8601": "2024-04-22T23:48:05.546646Z",
"url": "https://files.pythonhosted.org/packages/55/c6/242485a4fc8cd3afa6f12bc2c3b670390d8ef62d5a46b50f6b758ddec40d/lsst_rsp-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4341918eb44184bcfae9a26d6174a1edf06b17651011195d6f0daafd2fac3ba",
"md5": "7b1b93a87ff1cf8e0d7e4db59a64fc0a",
"sha256": "d3b68c2c2af6e3187db67c11067d7f29c9e4f2c7dc94731ed32c31791c4ae11f"
},
"downloads": -1,
"filename": "lsst_rsp-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "7b1b93a87ff1cf8e0d7e4db59a64fc0a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 39103,
"upload_time": "2024-04-22T23:48:07",
"upload_time_iso_8601": "2024-04-22T23:48:07.355768Z",
"url": "https://files.pythonhosted.org/packages/a4/34/1918eb44184bcfae9a26d6174a1edf06b17651011195d6f0daafd2fac3ba/lsst_rsp-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 23:48:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lsst-sqre",
"github_project": "lsst-rsp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "lsst-rsp"
}
