| Name | ullyses-utils JSON |
| Version |
3.1.0
JSON |
| download |
| home_page | |
| Summary | ULLYSES utility files and scripts |
| upload_time | 2023-12-13 18:06:30 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
astronomy
jwst
simulations
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ullyses-utils
## About
This repository contains utility scripts and data files for use in the ULLYSES program.
## Installation
To use the utility scripts and files in this repository, simply install like so:
```
pip install ullyses-utils
```
## Usage
### Utility Scripts
This repo houses several utility scripts that are needed to creates ULLYSES HLSPs. Most are specific to this purpose, but some may be generally useful: specific functions in such scripts are described below.
**`match_aliases.match_aliases`**
Given an input target name, an attempt is made to match it to any aliases in the ULLYSES sample.
By default, this returns the matched HLSP name, which is the target name used in ULLYSES products. You may alternatively specify that the ULLYSES name (generally recognized target name, with special characters) or the SIMBAD name (target name resolvable by SIMBAD) be returned instead.
```
from match_aliases import match_aliases
match_aliases("BAT99 105")
match_aliases("BAT99 105", return_name="target_name_ullyses")
match_aliases("BAT99 105", return_name="target_name_simbad")
```
### Utility data files
To use the utility data files, the package should be imported and then relative paths can be determined from your local installation.
For example, if you wish to reference the ULLYSES target alias file, you would do so like this:
```
import os
import ullyses_utils
local_dir = ullyses_utils.__path__[0]
alias_file = os.path.join(local_dir, "data/target_metadata/pd_all_aliases.json")
```
Raw data
{
"_id": null,
"home_page": "",
"name": "ullyses-utils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "astronomy,jwst,simulations",
"author": "",
"author_email": "ULLYSES STScI Team <ullyses_dp@stsci.edu>",
"download_url": "https://files.pythonhosted.org/packages/12/9c/43dccebc97bf676bf297fca6e6c9e6a1a2be93252540b4a832fdf7b87149/ullyses_utils-3.1.0.tar.gz",
"platform": null,
"description": "# ullyses-utils\n\n## About\n\nThis repository contains utility scripts and data files for use in the ULLYSES program.\n\n## Installation\n\nTo use the utility scripts and files in this repository, simply install like so:\n```\npip install ullyses-utils\n```\n## Usage\n\n### Utility Scripts\nThis repo houses several utility scripts that are needed to creates ULLYSES HLSPs. Most are specific to this purpose, but some may be generally useful: specific functions in such scripts are described below.\n\n**`match_aliases.match_aliases`**\n\nGiven an input target name, an attempt is made to match it to any aliases in the ULLYSES sample.\nBy default, this returns the matched HLSP name, which is the target name used in ULLYSES products. You may alternatively specify that the ULLYSES name (generally recognized target name, with special characters) or the SIMBAD name (target name resolvable by SIMBAD) be returned instead.\n\n```\nfrom match_aliases import match_aliases\nmatch_aliases(\"BAT99 105\")\nmatch_aliases(\"BAT99 105\", return_name=\"target_name_ullyses\")\nmatch_aliases(\"BAT99 105\", return_name=\"target_name_simbad\")\n```\n\n### Utility data files\n\nTo use the utility data files, the package should be imported and then relative paths can be determined from your local installation.\nFor example, if you wish to reference the ULLYSES target alias file, you would do so like this:\n```\nimport os\nimport ullyses_utils\nlocal_dir = ullyses_utils.__path__[0]\nalias_file = os.path.join(local_dir, \"data/target_metadata/pd_all_aliases.json\")\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "ULLYSES utility files and scripts",
"version": "3.1.0",
"project_urls": null,
"split_keywords": [
"astronomy",
"jwst",
"simulations"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6db32fa4d84606328fb021e01088eb9323ca39292021813c7d050831e0a07145",
"md5": "c190af384342e109103ccc3e119590bd",
"sha256": "3d810d89be99eef4cb2033fd1afbfb0cc36f4716db2a1e4ce182325e466a78b4"
},
"downloads": -1,
"filename": "ullyses_utils-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c190af384342e109103ccc3e119590bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3909932,
"upload_time": "2023-12-13T18:06:27",
"upload_time_iso_8601": "2023-12-13T18:06:27.918404Z",
"url": "https://files.pythonhosted.org/packages/6d/b3/2fa4d84606328fb021e01088eb9323ca39292021813c7d050831e0a07145/ullyses_utils-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "129c43dccebc97bf676bf297fca6e6c9e6a1a2be93252540b4a832fdf7b87149",
"md5": "275b2341ed55730bf6cc0028b15d5bb0",
"sha256": "ba146ff2d778f93ee76abbde47ef1983b13a2f00a250f3226dbf5d5fb7f02563"
},
"downloads": -1,
"filename": "ullyses_utils-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "275b2341ed55730bf6cc0028b15d5bb0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3561460,
"upload_time": "2023-12-13T18:06:30",
"upload_time_iso_8601": "2023-12-13T18:06:30.076601Z",
"url": "https://files.pythonhosted.org/packages/12/9c/43dccebc97bf676bf297fca6e6c9e6a1a2be93252540b4a832fdf7b87149/ullyses_utils-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-13 18:06:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ullyses-utils"
}
