canuvit

To carry out UVIT safety checks

https://github.com/prajwel/canuvit

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.3%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

To carry out UVIT safety checks

Basic Info
  • Host: GitHub
  • Owner: prajwel
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 970 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 1
  • Open Issues: 3
  • Releases: 1
Created over 4 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

CanUVIT

To check whether a field can be safely observed with UVIT.

You can install the CanUVIT Python package using the following command.

bash pip install canuvit --upgrade

IMPORTANT: Even if you have CanUVIT already installed, make sure you use the latest version by running the above command. Current version of CanUVIT is shown on the badge below:

Note: If you don't want to install CanUVIT or are facing problems during installation, You can run it online using Binder:
Binder

After installation, you can run CanUVIT on a Python command prompt or as a script. For example, if your primary instrument is UVIT and the RA, DEC coordinates of the field are (12:12:12, 12:12:12), you may run the CanUVIT package as follows.

```python

import canuvit canuvit.observe('uvit', '12:12:12', '12:12:12') ```

Note: In general, canuvit.observe(instrument, RA, DEC) where the instrument can be either 'uvit', 'sxt', 'czti', or 'laxpc' and RA and DEC field coordinates should be in sexagesimal format.

IMPORTANT: Make sure you choose the correct primary instrument. Incorrect choice of instrument may lead to proposal rejection.

For the above example, you should get an output as shown below. Please also check the working directory for the output GALEX images with sources marked in the primary instrument field of view.

```

Primary instrument: UVIT, Coordinates: 12:12:12, 12:12:12

VIS

slno rahms dec_dms mag B-V SpecType VIS3 VIS2 VIS1 ND1 BK7


1 12:11:52.8 +12:07:47.5 11.1 0.9       K1 1333.0 124.4  88.6 29.7 1624.9
2 12:12:22.9 +12:17:23.9 11.1 0.8       K0 1296.7 121.0  86.2 28.9 1580.6
3 12:11:35.0 +12:12:04.6 11.4 0.5       F5 1457.4 234.9 180.9 32.8 1915.2
4 12:11:01.7 +12:08:35.9 11.9 0.7       G5  754.3  89.1  69.2 16.8  950.9
5 12:11:11.5 +12:03:14.0 12.2 0.3       F0  803.1 143.5 101.4 18.2 1061.7
6 12:12:05.5 +12:19:09.8 12.3 0.8       K0  452.9  42.3  30.1 10.1  552.1

Safe filters: ['VIS3', 'VIS2', 'VIS1', 'ND1', 'BK7']

FUV observations seem to be absent! Using Mfuv = Mnuv - 1.65.

NUV

slno rahms decdms Mag Magcorrected silica b4 b13 b15 n2


1 12:12:32.4 +12:07:27.4 19.3          19.3    1.9 0.4 0.5 0.1 0.1
2 12:11:11.7 +12:03:14.8 16.2          16.2   31.8 7.0 8.6 2.3 1.7
3 12:12:41.1 +12:14:58.3 16.2          16.2   34.7 7.6 9.4 2.6 1.9
4 12:12:15.3 +12:29:18.1 19.5          19.5    1.6 0.3 0.4 0.1 0.1
5 12:11:35.0 +12:12:04.7 16.5          16.5   25.9 5.7 7.0 1.9 1.4

Safe filters in NUV: ['Silica', 'NUV-grating', 'NUV-B4', 'NUV-B13', 'NUV-B15', 'NUV-N2']

FUV

slno rahms decdms Mag Magcorrected caf2 baf2 sapphire silica


1 12:12:32.4 +12:07:27.4 19.3          17.7  1.7  1.4      1.0    0.4
2 12:11:11.7 +12:03:14.8 16.2          14.6 28.2 23.9     17.7    6.2
3 12:12:41.1 +12:14:58.3 16.2          14.5 30.7 26.1     19.4    6.8
4 12:12:15.3 +12:29:18.1 19.5          17.8  1.4  1.2      0.9    0.3
5 12:11:35.0 +12:12:04.7 16.5          14.8 23.0 19.6     14.5    5.1

Safe filters in FUV: ['CaF2', 'FUV-grating', 'BaF2', 'Sapphire', 'Silica'] ```

Please choose the VIS filters such that none of the stars in the field gives >4800 counts/second. Further, for good tracking of the aspect, there should be at least two stars within a 12 arcminute radius of the target with >30 counts/second (for good S/N) and <1000 counts/second (to avoid saturation) in the chosen filter. Please also avoid configuring multiple VIS filters.

Note: You will receive a warning if there are pairs of stars that are closer than 10 arcseconds in the VIS channel. In such cases, ensure the total count rate from the pairs of stars does not exceed the 4800 counts/seconds limit.

Two additional functions are also available, which takes the same input arguments as canuvit.observe().

  • canuvit.observe_VIS(): to find safe VIS filters.
  • canuvit.observe_UV(): to find safe UV filters.

Command Line Interface

After installation with pip, you can also access CanUVIT from the command line. Here's an example:

bash canuvit -i uvit -r "12:12:12" -d "12:12:12" The help page of the command-line tool can be accessed as follows:

bash canuvit -h

``` Usage: canuvit [OPTIONS]

Program to check if a given coordinate can be safely observed using UVIT.

Example usage: canuvit -r "13:12:14" -d "-14:15:13"

Options: --all Check safety for all filters. [default: all] --vis Check saftey for only visible filters. --uv Check safety for only UV filters. -r, --ra RA Right ascension of the coordinate. Format: hh:mm:ss[.ss] e.g. "00:54:53.45" [required] -d, --dec DEC Declination of the coordinate. Format: [-]dd:mm:ss[.ss] e.g. "-37:41:03.23". [required] -i, --instrument [uvit|sxt|czti|laxpc] Instrument to check for. [default: uvit] -v, --verbose Increase output verbosity. --version Show the version and exit. -h, --help Show this message and exit. ```

Acknowledgements

CanUVIT depends on the following web tools and API for its functioning.

  • Bright Source Warning Tool (https://uvit.iiap.res.in/Software/bswt)
  • Exposure Time Calculator (https://uvit.iiap.res.in/Software/etc)
  • MAST API (https://mast.stsci.edu/api/v0/)

Requirements

CanUVIT works with Python 3.6 or later. CanUVIT depends on the following packages:

  • astropy
  • astroquery
  • beautifulsoup4
  • click
  • matplotlib
  • numpy
  • requests

Owner

  • Name: Prajwel Joseph
  • Login: prajwel
  • Kind: user

Citation (CITATION.cff)

abstract: To carry out UVIT safety checks
authors:
- family-names: Prajwel Joseph
- affiliation: Indian Institute of Astrophysics
  family-names: Sriram Krishna
cff-version: 1.2.0
date-released: '2024-01-02'
doi: 10.5281/zenodo.10450289
license:
- cc-by-4.0
repository-code: https://github.com/prajwel/canuvit/tree/v0.5.0
title: 'prajwel/canuvit: v0.5.0'
type: software
version: v0.5.0

GitHub Events

Total
  • Issues event: 1
Last Year
  • Issues event: 1

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 39
  • Total Committers: 2
  • Avg Commits per committer: 19.5
  • Development Distribution Score (DDS): 0.256
Top Committers
Name Email Commits
prajwel p****j@g****m 29
Sriram Krishna k****1@g****m 10

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 5
  • Total pull requests: 2
  • Average time to close issues: about 4 hours
  • Average time to close pull requests: about 9 hours
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 4.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • prajwel (5)
Pull Request Authors
  • k-sriram (2)
Top Labels
Issue Labels
Pull Request Labels
enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 90 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 20
  • Total maintainers: 1
pypi.org: canuvit

UVIT safety checks

  • Versions: 20
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 90 Last month
Rankings
Dependent packages count: 10.1%
Downloads: 18.2%
Average: 20.1%
Dependent repos count: 21.6%
Forks count: 22.7%
Stargazers count: 27.9%
Maintainers (1)
Last synced: 8 months ago

Dependencies

pyproject.toml pypi