kosmos-craftroom 0.0.5__tar.gz

kosmos_craftroom-0.0.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Zach Berta-Thompson
+
+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.

kosmos_craftroom-0.0.5/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: kosmos-craftroom
+Version: 0.0.5
+Summary: Tools for working with spectroscopic light curves (of transiting exoplanets).
+Home-page: https://github.com/zkbt/kosmos-craftroom/
+Author: Zach Berta-Thompson
+Author-email: zach.bertathompson@colorado.edu
+License: MIT
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Requires-Python: >=3.7
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: astropy
+Requires-Dist: jupyter
+Requires-Dist: ipympl
+Requires-Dist: ipywidgets
+Requires-Dist: tqdm
+Requires-Dist: pyperclip
+Requires-Dist: thefriendlystars>=0.1.2
+Requires-Dist: illumination>=0.1.0
+Provides-Extra: develop
+Requires-Dist: pytest; extra == "develop"
+Requires-Dist: black; extra == "develop"
+Requires-Dist: jupyter; extra == "develop"
+Requires-Dist: ipython; extra == "develop"
+Requires-Dist: mkdocs; extra == "develop"
+Requires-Dist: mkdocs-material; extra == "develop"
+Requires-Dist: mkdocstrings; extra == "develop"
+Requires-Dist: mkdocstrings-python; extra == "develop"
+Requires-Dist: pytkdocs[numpy-style]; extra == "develop"
+Requires-Dist: mkdocs-jupyter; extra == "develop"
+Requires-Dist: mkdocs-exclude; extra == "develop"
+Requires-Dist: twine; extra == "develop"
+Requires-Dist: pre-commit; extra == "develop"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+Read the complete documentation at https://zkbt.github.io/kosmos-craftroom/

kosmos_craftroom-0.0.5/README.md

@@ -0,0 +1,40 @@
+# kosmos-craftroom
+A cheerful mess of tools for working with the KOSMOS spectrograph at APO.
+
+# Documentation
+Read (draft!) [documentation](https://zkbt.github.io/kosmos-craftroom).
+
+# Installation
+
+For installing this code we assume you have a Python environment set up, into which you can install packages via `pip`. If so, please continue to one of the installation options below.
+
+If this isn't the case, we recommend installing the [Anaconda Python distribution](https://www.anaconda.com/products/distribution), and using `conda` to manage the `python` environment(s) you have installed on your computer. One tutorial (of many) about how to get started with Python and creating `conda` environments is available [here](https://github.com/ers-transit/hackathon-2021-day0).
+
+## Basic Installation
+
+If you want to install into your current environment, the basic installation should be pretty simple. From the Terminal or Anaconda Prompt, please run
+```
+pip install https://github.com/zkbt/kosmos-craftroom
+```
+and it should install everything, along with all the necessary dependencies.
+
+If you previously installed this package and need to grab a newer version, run
+```
+pip install --upgrade https://github.com/zkbt/kosmos-craftroom
+```
+to download any officially released updates.
+
+## Developer Installation
+
+If you want to install this code while being able to edit and develop it, you can clone its [GitHub repository](https://github.com/zkbt/thefriendlystars.git) onto your own computer. This allows you to edit it for your own sake and/or to draft changes that can be contributed to the public package (after being added as a collaborator to the project on GitHub).
+
+To install directly as an editable package on your local computer, run
+```
+git clone git+https://github.com/zkbt/kosmos-craftroom
+cd kosmos-craftroom
+pip install -e '.[develop]'
+```
+The `-e .` will point your environment's `kosmoscraftroom` package to your local folder, meaning that any changes you make in the repository will be reflected in what Python sees when it tries to `import kosmoscraftroom`. Including the `[develop]` after the `.` will install both the dependencies for the package itself and the extra dependencies required for development (= testing and documentation).
+
+## Did it work?
+You can quickly test whether your installation worked, and what version you have, by running the Python code

kosmos_craftroom-0.0.5/kosmos_craftroom.egg-info/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: kosmos-craftroom
+Version: 0.0.5
+Summary: Tools for working with spectroscopic light curves (of transiting exoplanets).
+Home-page: https://github.com/zkbt/kosmos-craftroom/
+Author: Zach Berta-Thompson
+Author-email: zach.bertathompson@colorado.edu
+License: MIT
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Requires-Python: >=3.7
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: astropy
+Requires-Dist: jupyter
+Requires-Dist: ipympl
+Requires-Dist: ipywidgets
+Requires-Dist: tqdm
+Requires-Dist: pyperclip
+Requires-Dist: thefriendlystars>=0.1.2
+Requires-Dist: illumination>=0.1.0
+Provides-Extra: develop
+Requires-Dist: pytest; extra == "develop"
+Requires-Dist: black; extra == "develop"
+Requires-Dist: jupyter; extra == "develop"
+Requires-Dist: ipython; extra == "develop"
+Requires-Dist: mkdocs; extra == "develop"
+Requires-Dist: mkdocs-material; extra == "develop"
+Requires-Dist: mkdocstrings; extra == "develop"
+Requires-Dist: mkdocstrings-python; extra == "develop"
+Requires-Dist: pytkdocs[numpy-style]; extra == "develop"
+Requires-Dist: mkdocs-jupyter; extra == "develop"
+Requires-Dist: mkdocs-exclude; extra == "develop"
+Requires-Dist: twine; extra == "develop"
+Requires-Dist: pre-commit; extra == "develop"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+Read the complete documentation at https://zkbt.github.io/kosmos-craftroom/

kosmos_craftroom-0.0.5/kosmos_craftroom.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+LICENSE
+README.md
+setup.py
+kosmos_craftroom.egg-info/PKG-INFO
+kosmos_craftroom.egg-info/SOURCES.txt
+kosmos_craftroom.egg-info/dependency_links.txt
+kosmos_craftroom.egg-info/not-zip-safe
+kosmos_craftroom.egg-info/requires.txt
+kosmos_craftroom.egg-info/top_level.txt
+kosmoscraftroom/__init__.py
+kosmoscraftroom/catalogs.py
+kosmoscraftroom/detector.py
+kosmoscraftroom/finder.py
+kosmoscraftroom/iplot.py
+kosmoscraftroom/loupe.py
+kosmoscraftroom/scripts.py
+kosmoscraftroom/slit.py
+kosmoscraftroom/version.py

kosmos_craftroom-0.0.5/kosmos_craftroom.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

kosmos_craftroom-0.0.5/kosmos_craftroom.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

kosmos_craftroom-0.0.5/kosmos_craftroom.egg-info/requires.txt

@@ -0,0 +1,26 @@
+numpy
+scipy
+matplotlib
+astropy
+jupyter
+ipympl
+ipywidgets
+tqdm
+pyperclip
+thefriendlystars>=0.1.2
+illumination>=0.1.0
+
+[develop]
+pytest
+black
+jupyter
+ipython
+mkdocs
+mkdocs-material
+mkdocstrings
+mkdocstrings-python
+pytkdocs[numpy-style]
+mkdocs-jupyter
+mkdocs-exclude
+twine
+pre-commit

kosmos_craftroom-0.0.5/kosmos_craftroom.egg-info/top_level.txt

@@ -0,0 +1 @@
+kosmoscraftroom

kosmos_craftroom-0.0.5/kosmoscraftroom/__init__.py

@@ -0,0 +1 @@
+from .version import *

kosmos_craftroom-0.0.5/kosmoscraftroom/catalogs.py

@@ -0,0 +1,162 @@
+from astropy.table import Table, vstack, unique
+from astropy.coordinates import SkyCoord
+from astropy.io.ascii import read
+import astropy.units as u
+
+import numpy as np
+
+
+class TUICatalog:
+    """
+    Tool to make a TUI catalog, as outlined in this documentation:
+    https://www.apo.nmsu.edu/35m_operations/TUI/Telescope/UserCatalogs.html
+
+    """
+
+    def __init__(self, name="?"):
+        """
+        Initialize a catalog
+        """
+        self.name = name
+        self.table = []
+
+    def __repr__(self):
+        return f"<'{self.name}' TUICatalog ({len(self.table)} targets)>"
+
+    def from_table(self, table, remove_duplicates=True, sort=True):
+        """
+        Initialize from a table.
+        """
+        self.table = table
+        if remove_duplicates:
+            self.remove_duplicates()
+        if sort:
+            self.sort()
+
+    def from_TUI(self, filename, names=["name", "ra", "dec"]):
+        t = read(filename, names=names)
+        table = Table(
+            dict(
+                names=t["name"],
+                sky_coordinates=SkyCoord(
+                    ra=t["ra"],
+                    dec=t["dec"],
+                    unit=(u.hourangle, u.deg),  # TO-DO make sure this is more general!!
+                ),
+                category=[self.name for i in range(len(t))],
+            )
+        )
+        self.from_table(table)
+
+    def from_exoatlas(self, pop):
+        """
+        Initialize from an exoplanet-atlas population.
+        """
+        self._exoatlas_pop = pop
+        table = Table(
+            dict(
+                names=pop.standard["hostname"],
+                sky_coordinates=SkyCoord(pop.standard["ra"], pop.standard["dec"]),
+                G=pop.standard["gaiamag"],
+                distance=pop.standard["distance"],
+                category=[self.name for i in range(len(pop.standard))],
+            )
+        )
+        self.from_table(table)
+
+    def remove_duplicates(self):
+        self.table = unique(self.table, keys=["names"])
+
+    def sort(self):
+        self.table = self.table[np.argsort(self.table["sky_coordinates"].ra)]
+
+    def make_three_columns(self, row):
+        return f"""{row['names'].replace(' ', ''):<20} {row['sky_coordinates'].to_string('hmsdms', sep=':', precision=1)}"""
+
+    def make_tui_columns(self, row):
+        keywords = []
+        return "; ".join(keywords)
+
+    def make_human_columns(self, row):
+        keywords = [
+            f"{row['category']}",
+            f"d={row['distance']:.1f}pc",
+            f"G={row['G']:.2f}",
+        ]
+        return ", ".join(keywords)
+
+    def to_TUI(self, parallactic=True, output=False, color="Black"):
+        """
+        Write this catalog out to a TUI-friendly format.
+
+        The catalog will be written out to a file set by the catalogs 'name' attribute,
+        in a format that can be loaded into TUI via the Slew > Catalogs button.
+
+        Parameters
+        ----------
+        parallactic : bool
+            Should we rotate the slit to be along the parallactic angle?
+            Doing so will minimize the effects of differental refraction
+            through Earth's atmosphere on the amount light that enters
+            the slit.
+        output : bool
+            Should we print the catalog to the screen?
+        """
+        filename = f"{self.name}.tui"
+        if parallactic:
+            preamble = f"CSys=ICRS; RotType=Horizon; RotAng=90; DispColor={color}"
+        else:
+            preamble = f"CSys=ICRS; RotType=Object; RotAng=0; DispColor={color}"
+
+        lines = [
+            f"""{self.make_three_columns(row)}   {self.make_tui_columns(row)}\n"""
+            for row in self.table
+        ]
+
+        with open(filename, "w") as f:
+            f.write(preamble)
+            f.write("\n" * 3)
+            f.writelines(lines)
+
+        if output:
+            with open(filename, "r") as f:
+                print(f.read())
+
+        print(f"{self} has been saved to {filename}")
+
+    def to_human_friendly(self, output=False):
+        """
+        Write this catalog out to a human-friendly format.
+
+        The catalog will be written with the same initial columns as a TUI catalog,
+        but with additional information that might help in observation planning,
+        such as the category of observing program, the distance, the magnitude.
+        """
+        filename = f"{self.name}.txt"
+        lines = [
+            f"""{self.make_three_columns(row)}   {self.make_human_columns(row)}\n"""
+            for row in self.table
+        ]
+
+        with open(filename, "w") as f:
+            f.writelines(lines)
+
+        if output:
+            with open(filename, "r") as f:
+                print(f.read())
+
+        print(
+            f"Human-friendly catalog ({len(self.table)} targets) has been saved to {filename}"
+        )
+
+    def __add__(self, other):
+        """
+        Merge two catalogs together.
+        """
+        new = TUICatalog(f"{self.name}+{other.name}")
+        new.table = vstack([self.table, other.table])
+        new.sort()
+        return new
+
+
+#    def to_human(self)G={row['G']:>5.2f}