diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-k2fov.spec | 735 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 737 insertions, 0 deletions
@@ -0,0 +1 @@ +/K2fov-8.0.0.tar.gz diff --git a/python-k2fov.spec b/python-k2fov.spec new file mode 100644 index 0000000..65b8599 --- /dev/null +++ b/python-k2fov.spec @@ -0,0 +1,735 @@ +%global _empty_manifest_terminate_build 0 +Name: python-K2fov +Version: 8.0.0 +Release: 1 +Summary: Find which targets are in the field of view of K2 +License: MIT License +URL: https://github.com/KeplerGO/K2fov +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/e9/83/6caf8a902c0837b7afcaaba82bafa11f8ca899cd934123c14454c5459f5d/K2fov-8.0.0.tar.gz +BuildArch: noarch + + +%description +# K2fov [](https://pypi.python.org/pypi/K2fov/) [](https://travis-ci.org/KeplerGO/K2fov) [](http://adsabs.harvard.edu/abs/2016ascl.soft01009M) +***Check whether targets are in the field of view of NASA's K2 mission.*** + +The `K2fov` Python package allows users to check whether a target is in the field of view of K2. +In particular, the package adds the `K2onSilicon` and `K2findCampaigns` tools +to the command line, which allow the visibility of targets to be checked +during one (`K2onSilicon`) or all (`K2findCampaigns`) campaigns, respectively. +The usage of these tools is explained below. + +## Installation + +You will need a modern version of Python 2 or 3 on your system. +If this requirement is met, you can install `K2fov` using `pip`: +```bash +pip install K2fov +``` +if you have a previous version installed, please make sure you upgrade to the +latest version using: +```bash +pip install K2fov --upgrade +``` +It is important to upgrade frequently to ensure that you are using the most +up to date K2 field parameters. + +If you require to install the latest development version, +e.g. to test a bugfix, then you can install +the package straight from the git repository as follows: +``` +git clone https://github.com/KeplerGO/K2fov.git +cd K2fov +python setup.py install +``` + + +## Usage + +### K2onSilicon + +Installing `K2fov` will automatically add a command line tool +to your path called `K2onSilicon`, which takes a list of targets +as input and writes a new list that indicates the "silicon status" +of each target, i.e. whether or not it falls on one of the +detectors of the spacecraft's focal plane. + +**Example** + +The simplest thing to do is to have a CSV file with columns +"RA_degrees, Dec_degrees, Kepmag". +Do not use a header. + +For example, create a file called `mytargetlist.csv` containing +the following rows: +```bash +178.19284, 1.01924, 13.2 +171.14213, 5.314616, 11.3 +``` +The format for the target list is very strict -- you need three +columns: RA in degrees, Declination in degrees and Kepler +magnitude. Headers or other additional columns will cause an execution +failure. + +You can then check whether each object in the file falls on silicon +by calling `K2onSilicon` from the command line: +```bash +K2onSilicon mytargetlist.csv 1 +``` +Where `mytargetlist.csv` is your CSV file and `1` is the K2 Campaign number. + +Running the code will output an updated target list containing the three input columns and an extra column containing either a "0" or "2".<br> +0 = Not observable<br> +2 = Target is in the K2 field of view and on silicon<br> + +The code will also write an image, called `targets_fov.png`, showing where the targets fall. + +Execute `K2onSilicon --help` to be reminded of its usage: +``` +$ K2onSilicon --help +usage: K2onSilicon [-h] csv_file campaign + +Run K2onSilicon to find which targets in a list call on active silicon for a +given K2 campaign. + +positional arguments: + csv_file Name of input csv file with targets, column are Ra_degrees, + Dec_degrees, Kepmag + campaign K2 Campaign number + +optional arguments: + -h, --help show this help message and exit +``` + + +### K2findCampaigns + +If instead of checking the targets in a single campaign, +you want to understand whether a target is visible in *any* past or +future K2 Campaign, you can use a different tool called `K2findCampaigns`. + +**Example** + +For example, to verify whether J2000 coordinate +(ra, dec) = (269.5, -28.5) degrees is visible at any point +during the K2 mission, type: +``` +$ K2findCampaigns 269.5 -28.5 +Success! The target is on silicon during K2 campaigns [9]. +Position in C9: channel 31, col 613, row 491. +``` + +You can also search by name. +For example, to check whether *T Tauri* is visible, type: +``` +$ K2findCampaigns-byname "T Tauri" +Success! T Tauri is on silicon during K2 campaigns [4]. +Position in C4: channel 3, col 62, row 921. +``` + +Finally, you can check a list of targets (either using their coordinates or names), using `K2findCampaigns-csv`. +For example: +``` +$ K2findCampaigns-csv targets.csv +Writing targets.csv-K2findCampaigns.csv. +``` + +**More information** + +Execute `K2findCampaigns --help`, `K2findCampaigns-byname --help` or `K2findCampaigns-csv --help` to be reminded of the use: +``` +$ K2findCampaigns --help +usage: K2findCampaigns [-h] [-p] ra dec + +Check if a celestial coordinate is (or was) observable by any past or future +observing campaign of NASA's K2 mission. + +positional arguments: + ra Right Ascension in decimal degrees (J2000). + dec Declination in decimal degrees (J2000). + +optional arguments: + -h, --help show this help message and exit + -p, --plot Produce a plot showing the target position with respect to all + K2 campaigns. +``` + +``` +K2findCampaigns-byname --help +usage: K2findCampaigns-byname [-h] [-p] name + +Check if a target is (or was) observable by any past or future observing +campaign of NASA's K2 mission. + +positional arguments: + name Name of the object. This will be passed on to the CDS name + resolver to retrieve coordinate information. + +optional arguments: + -h, --help show this help message and exit + -p, --plot Produce a plot showing the target position with respect to all + K2 campaigns. +``` + +``` +$ K2findCampaigns-csv --help +usage: K2findCampaigns-csv [-h] input_filename + +Check which objects listed in a CSV table are (or were) observable by NASA's +K2 mission. + +positional arguments: + input_filename Path to a comma-separated table containing columns + 'ra,dec,kepmag' (decimal degrees) or 'name'. + +optional arguments: + -h, --help show this help message and exit +``` + + +### K2inMicrolensRegion + +Finally, this package adds the `K2inMicrolensRegion` tool to check if a +celestial coordinate is inside the 3-megapixel superstamp region +that has been allocated to the [Campaign 9 microlensing experiment](http://keplerscience.arc.nasa.gov/k2-c9.html). +The stamp covers a large, ~contiguous region towards the Galactic Bulge. +``` +$ K2inMicrolensRegion --help +usage: K2inMicrolensRegion [-h] ra dec + +Check if a celestial coordinate is inside the K2C9 microlensing superstamp. + +positional arguments: + ra Right Ascension in decimal degrees (J2000). + dec Declination in decimal degrees (J2000). + +optional arguments: + -h, --help show this help message and exit +``` + + +## Attribution + +`K2fov` was created by Fergal Mullally, Thomas Barclay, and Geert Barentsen +for NASA's Kepler/K2 Guest Observer Office. +If this tool aided your research, please cite it using the ADS bibcode +([2016ascl.soft01009M](http://adsabs.harvard.edu/abs/2016ascl.soft01009M)) +and its DOI identifier ([10.5281/zenodo.44283](https://zenodo.org/record/44283)). + +The BibTeX entry is as follows: +``` +@MISC{2016ascl.soft01009M, + author = {{Mullally}, Fergal; {Barclay}, Thomas; {Barentsen}, Geert}, + title = "{K2fov: Field of view software for NASA's K2 mission}", + howpublished = {Astrophysics Source Code Library}, + year = 2016, + month = jan, + archivePrefix = "ascl", + eprint = {1601.009}, + adsurl = {http://adsabs.harvard.edu/abs/2016ascl.soft01009M}, + adsnote = {Provided by the SAO/NASA Astrophysics Data System}, + doi = {10.5281/zenodo.44283}, + url = {http://dx.doi.org/10.5281/zenodo.44283} +} +``` + +%package -n python3-K2fov +Summary: Find which targets are in the field of view of K2 +Provides: python-K2fov +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-K2fov +# K2fov [](https://pypi.python.org/pypi/K2fov/) [](https://travis-ci.org/KeplerGO/K2fov) [](http://adsabs.harvard.edu/abs/2016ascl.soft01009M) +***Check whether targets are in the field of view of NASA's K2 mission.*** + +The `K2fov` Python package allows users to check whether a target is in the field of view of K2. +In particular, the package adds the `K2onSilicon` and `K2findCampaigns` tools +to the command line, which allow the visibility of targets to be checked +during one (`K2onSilicon`) or all (`K2findCampaigns`) campaigns, respectively. +The usage of these tools is explained below. + +## Installation + +You will need a modern version of Python 2 or 3 on your system. +If this requirement is met, you can install `K2fov` using `pip`: +```bash +pip install K2fov +``` +if you have a previous version installed, please make sure you upgrade to the +latest version using: +```bash +pip install K2fov --upgrade +``` +It is important to upgrade frequently to ensure that you are using the most +up to date K2 field parameters. + +If you require to install the latest development version, +e.g. to test a bugfix, then you can install +the package straight from the git repository as follows: +``` +git clone https://github.com/KeplerGO/K2fov.git +cd K2fov +python setup.py install +``` + + +## Usage + +### K2onSilicon + +Installing `K2fov` will automatically add a command line tool +to your path called `K2onSilicon`, which takes a list of targets +as input and writes a new list that indicates the "silicon status" +of each target, i.e. whether or not it falls on one of the +detectors of the spacecraft's focal plane. + +**Example** + +The simplest thing to do is to have a CSV file with columns +"RA_degrees, Dec_degrees, Kepmag". +Do not use a header. + +For example, create a file called `mytargetlist.csv` containing +the following rows: +```bash +178.19284, 1.01924, 13.2 +171.14213, 5.314616, 11.3 +``` +The format for the target list is very strict -- you need three +columns: RA in degrees, Declination in degrees and Kepler +magnitude. Headers or other additional columns will cause an execution +failure. + +You can then check whether each object in the file falls on silicon +by calling `K2onSilicon` from the command line: +```bash +K2onSilicon mytargetlist.csv 1 +``` +Where `mytargetlist.csv` is your CSV file and `1` is the K2 Campaign number. + +Running the code will output an updated target list containing the three input columns and an extra column containing either a "0" or "2".<br> +0 = Not observable<br> +2 = Target is in the K2 field of view and on silicon<br> + +The code will also write an image, called `targets_fov.png`, showing where the targets fall. + +Execute `K2onSilicon --help` to be reminded of its usage: +``` +$ K2onSilicon --help +usage: K2onSilicon [-h] csv_file campaign + +Run K2onSilicon to find which targets in a list call on active silicon for a +given K2 campaign. + +positional arguments: + csv_file Name of input csv file with targets, column are Ra_degrees, + Dec_degrees, Kepmag + campaign K2 Campaign number + +optional arguments: + -h, --help show this help message and exit +``` + + +### K2findCampaigns + +If instead of checking the targets in a single campaign, +you want to understand whether a target is visible in *any* past or +future K2 Campaign, you can use a different tool called `K2findCampaigns`. + +**Example** + +For example, to verify whether J2000 coordinate +(ra, dec) = (269.5, -28.5) degrees is visible at any point +during the K2 mission, type: +``` +$ K2findCampaigns 269.5 -28.5 +Success! The target is on silicon during K2 campaigns [9]. +Position in C9: channel 31, col 613, row 491. +``` + +You can also search by name. +For example, to check whether *T Tauri* is visible, type: +``` +$ K2findCampaigns-byname "T Tauri" +Success! T Tauri is on silicon during K2 campaigns [4]. +Position in C4: channel 3, col 62, row 921. +``` + +Finally, you can check a list of targets (either using their coordinates or names), using `K2findCampaigns-csv`. +For example: +``` +$ K2findCampaigns-csv targets.csv +Writing targets.csv-K2findCampaigns.csv. +``` + +**More information** + +Execute `K2findCampaigns --help`, `K2findCampaigns-byname --help` or `K2findCampaigns-csv --help` to be reminded of the use: +``` +$ K2findCampaigns --help +usage: K2findCampaigns [-h] [-p] ra dec + +Check if a celestial coordinate is (or was) observable by any past or future +observing campaign of NASA's K2 mission. + +positional arguments: + ra Right Ascension in decimal degrees (J2000). + dec Declination in decimal degrees (J2000). + +optional arguments: + -h, --help show this help message and exit + -p, --plot Produce a plot showing the target position with respect to all + K2 campaigns. +``` + +``` +K2findCampaigns-byname --help +usage: K2findCampaigns-byname [-h] [-p] name + +Check if a target is (or was) observable by any past or future observing +campaign of NASA's K2 mission. + +positional arguments: + name Name of the object. This will be passed on to the CDS name + resolver to retrieve coordinate information. + +optional arguments: + -h, --help show this help message and exit + -p, --plot Produce a plot showing the target position with respect to all + K2 campaigns. +``` + +``` +$ K2findCampaigns-csv --help +usage: K2findCampaigns-csv [-h] input_filename + +Check which objects listed in a CSV table are (or were) observable by NASA's +K2 mission. + +positional arguments: + input_filename Path to a comma-separated table containing columns + 'ra,dec,kepmag' (decimal degrees) or 'name'. + +optional arguments: + -h, --help show this help message and exit +``` + + +### K2inMicrolensRegion + +Finally, this package adds the `K2inMicrolensRegion` tool to check if a +celestial coordinate is inside the 3-megapixel superstamp region +that has been allocated to the [Campaign 9 microlensing experiment](http://keplerscience.arc.nasa.gov/k2-c9.html). +The stamp covers a large, ~contiguous region towards the Galactic Bulge. +``` +$ K2inMicrolensRegion --help +usage: K2inMicrolensRegion [-h] ra dec + +Check if a celestial coordinate is inside the K2C9 microlensing superstamp. + +positional arguments: + ra Right Ascension in decimal degrees (J2000). + dec Declination in decimal degrees (J2000). + +optional arguments: + -h, --help show this help message and exit +``` + + +## Attribution + +`K2fov` was created by Fergal Mullally, Thomas Barclay, and Geert Barentsen +for NASA's Kepler/K2 Guest Observer Office. +If this tool aided your research, please cite it using the ADS bibcode +([2016ascl.soft01009M](http://adsabs.harvard.edu/abs/2016ascl.soft01009M)) +and its DOI identifier ([10.5281/zenodo.44283](https://zenodo.org/record/44283)). + +The BibTeX entry is as follows: +``` +@MISC{2016ascl.soft01009M, + author = {{Mullally}, Fergal; {Barclay}, Thomas; {Barentsen}, Geert}, + title = "{K2fov: Field of view software for NASA's K2 mission}", + howpublished = {Astrophysics Source Code Library}, + year = 2016, + month = jan, + archivePrefix = "ascl", + eprint = {1601.009}, + adsurl = {http://adsabs.harvard.edu/abs/2016ascl.soft01009M}, + adsnote = {Provided by the SAO/NASA Astrophysics Data System}, + doi = {10.5281/zenodo.44283}, + url = {http://dx.doi.org/10.5281/zenodo.44283} +} +``` + +%package help +Summary: Development documents and examples for K2fov +Provides: python3-K2fov-doc +%description help +# K2fov [](https://pypi.python.org/pypi/K2fov/) [](https://travis-ci.org/KeplerGO/K2fov) [](http://adsabs.harvard.edu/abs/2016ascl.soft01009M) +***Check whether targets are in the field of view of NASA's K2 mission.*** + +The `K2fov` Python package allows users to check whether a target is in the field of view of K2. +In particular, the package adds the `K2onSilicon` and `K2findCampaigns` tools +to the command line, which allow the visibility of targets to be checked +during one (`K2onSilicon`) or all (`K2findCampaigns`) campaigns, respectively. +The usage of these tools is explained below. + +## Installation + +You will need a modern version of Python 2 or 3 on your system. +If this requirement is met, you can install `K2fov` using `pip`: +```bash +pip install K2fov +``` +if you have a previous version installed, please make sure you upgrade to the +latest version using: +```bash +pip install K2fov --upgrade +``` +It is important to upgrade frequently to ensure that you are using the most +up to date K2 field parameters. + +If you require to install the latest development version, +e.g. to test a bugfix, then you can install +the package straight from the git repository as follows: +``` +git clone https://github.com/KeplerGO/K2fov.git +cd K2fov +python setup.py install +``` + + +## Usage + +### K2onSilicon + +Installing `K2fov` will automatically add a command line tool +to your path called `K2onSilicon`, which takes a list of targets +as input and writes a new list that indicates the "silicon status" +of each target, i.e. whether or not it falls on one of the +detectors of the spacecraft's focal plane. + +**Example** + +The simplest thing to do is to have a CSV file with columns +"RA_degrees, Dec_degrees, Kepmag". +Do not use a header. + +For example, create a file called `mytargetlist.csv` containing +the following rows: +```bash +178.19284, 1.01924, 13.2 +171.14213, 5.314616, 11.3 +``` +The format for the target list is very strict -- you need three +columns: RA in degrees, Declination in degrees and Kepler +magnitude. Headers or other additional columns will cause an execution +failure. + +You can then check whether each object in the file falls on silicon +by calling `K2onSilicon` from the command line: +```bash +K2onSilicon mytargetlist.csv 1 +``` +Where `mytargetlist.csv` is your CSV file and `1` is the K2 Campaign number. + +Running the code will output an updated target list containing the three input columns and an extra column containing either a "0" or "2".<br> +0 = Not observable<br> +2 = Target is in the K2 field of view and on silicon<br> + +The code will also write an image, called `targets_fov.png`, showing where the targets fall. + +Execute `K2onSilicon --help` to be reminded of its usage: +``` +$ K2onSilicon --help +usage: K2onSilicon [-h] csv_file campaign + +Run K2onSilicon to find which targets in a list call on active silicon for a +given K2 campaign. + +positional arguments: + csv_file Name of input csv file with targets, column are Ra_degrees, + Dec_degrees, Kepmag + campaign K2 Campaign number + +optional arguments: + -h, --help show this help message and exit +``` + + +### K2findCampaigns + +If instead of checking the targets in a single campaign, +you want to understand whether a target is visible in *any* past or +future K2 Campaign, you can use a different tool called `K2findCampaigns`. + +**Example** + +For example, to verify whether J2000 coordinate +(ra, dec) = (269.5, -28.5) degrees is visible at any point +during the K2 mission, type: +``` +$ K2findCampaigns 269.5 -28.5 +Success! The target is on silicon during K2 campaigns [9]. +Position in C9: channel 31, col 613, row 491. +``` + +You can also search by name. +For example, to check whether *T Tauri* is visible, type: +``` +$ K2findCampaigns-byname "T Tauri" +Success! T Tauri is on silicon during K2 campaigns [4]. +Position in C4: channel 3, col 62, row 921. +``` + +Finally, you can check a list of targets (either using their coordinates or names), using `K2findCampaigns-csv`. +For example: +``` +$ K2findCampaigns-csv targets.csv +Writing targets.csv-K2findCampaigns.csv. +``` + +**More information** + +Execute `K2findCampaigns --help`, `K2findCampaigns-byname --help` or `K2findCampaigns-csv --help` to be reminded of the use: +``` +$ K2findCampaigns --help +usage: K2findCampaigns [-h] [-p] ra dec + +Check if a celestial coordinate is (or was) observable by any past or future +observing campaign of NASA's K2 mission. + +positional arguments: + ra Right Ascension in decimal degrees (J2000). + dec Declination in decimal degrees (J2000). + +optional arguments: + -h, --help show this help message and exit + -p, --plot Produce a plot showing the target position with respect to all + K2 campaigns. +``` + +``` +K2findCampaigns-byname --help +usage: K2findCampaigns-byname [-h] [-p] name + +Check if a target is (or was) observable by any past or future observing +campaign of NASA's K2 mission. + +positional arguments: + name Name of the object. This will be passed on to the CDS name + resolver to retrieve coordinate information. + +optional arguments: + -h, --help show this help message and exit + -p, --plot Produce a plot showing the target position with respect to all + K2 campaigns. +``` + +``` +$ K2findCampaigns-csv --help +usage: K2findCampaigns-csv [-h] input_filename + +Check which objects listed in a CSV table are (or were) observable by NASA's +K2 mission. + +positional arguments: + input_filename Path to a comma-separated table containing columns + 'ra,dec,kepmag' (decimal degrees) or 'name'. + +optional arguments: + -h, --help show this help message and exit +``` + + +### K2inMicrolensRegion + +Finally, this package adds the `K2inMicrolensRegion` tool to check if a +celestial coordinate is inside the 3-megapixel superstamp region +that has been allocated to the [Campaign 9 microlensing experiment](http://keplerscience.arc.nasa.gov/k2-c9.html). +The stamp covers a large, ~contiguous region towards the Galactic Bulge. +``` +$ K2inMicrolensRegion --help +usage: K2inMicrolensRegion [-h] ra dec + +Check if a celestial coordinate is inside the K2C9 microlensing superstamp. + +positional arguments: + ra Right Ascension in decimal degrees (J2000). + dec Declination in decimal degrees (J2000). + +optional arguments: + -h, --help show this help message and exit +``` + + +## Attribution + +`K2fov` was created by Fergal Mullally, Thomas Barclay, and Geert Barentsen +for NASA's Kepler/K2 Guest Observer Office. +If this tool aided your research, please cite it using the ADS bibcode +([2016ascl.soft01009M](http://adsabs.harvard.edu/abs/2016ascl.soft01009M)) +and its DOI identifier ([10.5281/zenodo.44283](https://zenodo.org/record/44283)). + +The BibTeX entry is as follows: +``` +@MISC{2016ascl.soft01009M, + author = {{Mullally}, Fergal; {Barclay}, Thomas; {Barentsen}, Geert}, + title = "{K2fov: Field of view software for NASA's K2 mission}", + howpublished = {Astrophysics Source Code Library}, + year = 2016, + month = jan, + archivePrefix = "ascl", + eprint = {1601.009}, + adsurl = {http://adsabs.harvard.edu/abs/2016ascl.soft01009M}, + adsnote = {Provided by the SAO/NASA Astrophysics Data System}, + doi = {10.5281/zenodo.44283}, + url = {http://dx.doi.org/10.5281/zenodo.44283} +} +``` + +%prep +%autosetup -n K2fov-8.0.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-K2fov -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 8.0.0-1 +- Package Spec generated @@ -0,0 +1 @@ +fa29e1446fe640518d3ad8ec5abdb082 K2fov-8.0.0.tar.gz |