quicklook-package 1.1.2__tar.gz → 1.2__tar.gz

{quicklook_package-1.1.2/quicklook_package.egg-info → quicklook_package-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quicklook-package
-Version: 1.1.2
+Version: 1.2
 Summary: Quicklook lightcurve plot generator
 Home-page: https://github.com/jpdeleon/quicklook
 Author-email: jpdeleon <jpdeleon.bsap@gmail.com>
@@ -25,30 +25,29 @@ Requires-Dist: astroplan==0.9
 Requires-Dist: loguru
 
 # QuickLook
-`quicklook` is a Python program that runs a simple pipeline to search for transit signal in TESS (and Kepler soon) light curves. This program can be run in a jupyter notebook (see [example](https://github.com/jpdeleon/quicklook/tree/main/notebook)) or from the terminal using the `ql` script.
+`quicklook` is a Python program that runs a simple pipeline to search for transit signal in TESS (and Kepler soon) light curves. This program can be run in a jupyter notebook or from the terminal using the `ql` script.
 
 ## Use case
 Given target name, run periodograms on a TESS or Kepler lightcurve (if it exists) to measure the stellar rotation period and the orbital period of a potential companion i.e. planet, brown dwarf, or star.
 Although `quicklook` is optimized to find transiting exoplanets, this tool can also find eclipsing binaries and many other periodic signals.
 
-## Try it on Google colab
-
-<a href="https://colab.research.google.com/github/jpdeleon/quicklook/blob/main/notebook/examples.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
-
-
 ## Installation
-Create a conda environment called, say `my_env`, and install there an editable version of `quicklook`
+Create a conda environment called, say `my_env`, and install there the latest version of `quicklook-package`
 ```bash
 $ conda create -n my_env python=3.10
 $ conda activate my_env
-(my_env) $ python -m python -m pip install -r https://raw.githubusercontent.com/jpdeleon/quicklook/main/requirements.txt
-(my_env) $ python -m pip install -e git+https://github.com/jpdeleon/quicklook.git#egg=quicklook
+(my_env) $ pip install -U quicklook-package
 ```
 
-If you want to run `quicklook` in a notebook, you also need to install jupyter
+If you want to run `quicklook` locally in a notebook, you also need to install jupyter
 ```
-(my_env) $ python -m pip install jupyterlab
+(my_env) $ pip install jupyter notebook
 ```
+See [example notebook](https://github.com/jpdeleon/quicklook/blob/main/notebook/examples.ipynb).
+
+## Try it on Google colab
+
+<a href="https://colab.research.google.com/github/jpdeleon/quicklook/blob/main/notebook/examples.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
 
 ## Command line script
 ```bash
@@ -63,7 +62,7 @@ Notes:
 * use single hyphen (-flag) if no value is needed.
 * use double hyphen (--flag value) if value is needed.
 
-Example: ql --name TOI-1234 --sector 27 -save -verbose
+Example: ql --name TOI-5071 --sector 46 -save -verbose
 
 options:
   -h, --help            show this help message and exit
@@ -101,12 +100,12 @@ options:
 
 ## Examples
 
-1. Run `quicklook` on the most recent TESS lightcurve of TOI 5071 (aka K2-100).
+1. Run `quicklook` on the most recent TESS lightcurve of TOI-5071 (aka K2-100).
 
 ```shell
 (my_env) $ ql --name TOI-5071
 ```
-![img](tests/k2-100_s46_pdcsap_sc.png)
+![img](tests/TOI5071_s46_pdcsap_sc.png)
 
 The figure above shows 9 panels. Let's break them down.
 * top row
@@ -124,7 +123,7 @@ The figure above shows 9 panels. Let's break them down.
 
 Try changing the parameters:
 ```shell
-(my_env) $ ql --name TIC52368076 -verbose -save | tee output.log
+(my_env) $ ql --name TIC-52368076 -verbose -save | tee output.log
 (my_env) $ ql --name TOI-125.01 --pipeline qlp #specific pipeline
 (my_env) $ ql --name TOI-125.01 --sector 2 #specific TESS sector
 (my_env) $ ql --name TOI-125.01 --flatten_method cosine #specific function to detrend baseline
@@ -133,10 +132,10 @@ Try changing the parameters:
 
 ## Advanced usage
 
-If you would like to run `ql` on a list of TIC IDs (saved as `tic_ids.txt`), then you can make a batch script named `run_ql_given_tic.batch`. The output files containing the plots (*.png) and periodogram results (*_tls.h5) will be saved in `tic_dir` directory:
+If you would like to run `ql` on a list of TIC IDs (saved as `tic_ids.txt`), then you can make a batch script named `run_ql_given_tic.batch`. The output files containing the logs (*.log), plots (*.png), and periodogram results (*_tls.h5) will be saved in `tic_dir` directory:
 
 ```shell
-(my_env) $ cat tic_ids.txt | while read tic; do echo ql --name TIC$tic -save --outdir tic_dir > TIC$tic.log 2>&1; done > run_ql_given_tic.batch
+(my_env) $ cat tic_ids.txt | while read tic; do echo ql --name TIC$tic -save --outdir tic_dir | tee TIC$tic.log; done > run_ql_given_tic.batch
 ```
 
 To test the Nth line of the batch script,

{quicklook_package-1.1.2 → quicklook_package-1.2}/README.md

@@ -1,28 +1,27 @@
 # QuickLook
-`quicklook` is a Python program that runs a simple pipeline to search for transit signal in TESS (and Kepler soon) light curves. This program can be run in a jupyter notebook (see [example](https://github.com/jpdeleon/quicklook/tree/main/notebook)) or from the terminal using the `ql` script.
+`quicklook` is a Python program that runs a simple pipeline to search for transit signal in TESS (and Kepler soon) light curves. This program can be run in a jupyter notebook or from the terminal using the `ql` script.
 
 ## Use case
 Given target name, run periodograms on a TESS or Kepler lightcurve (if it exists) to measure the stellar rotation period and the orbital period of a potential companion i.e. planet, brown dwarf, or star.
 Although `quicklook` is optimized to find transiting exoplanets, this tool can also find eclipsing binaries and many other periodic signals.
 
-## Try it on Google colab
-
-<a href="https://colab.research.google.com/github/jpdeleon/quicklook/blob/main/notebook/examples.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
-
-
 ## Installation
-Create a conda environment called, say `my_env`, and install there an editable version of `quicklook`
+Create a conda environment called, say `my_env`, and install there the latest version of `quicklook-package`
 ```bash
 $ conda create -n my_env python=3.10
 $ conda activate my_env
-(my_env) $ python -m python -m pip install -r https://raw.githubusercontent.com/jpdeleon/quicklook/main/requirements.txt
-(my_env) $ python -m pip install -e git+https://github.com/jpdeleon/quicklook.git#egg=quicklook
+(my_env) $ pip install -U quicklook-package
 ```
 
-If you want to run `quicklook` in a notebook, you also need to install jupyter
+If you want to run `quicklook` locally in a notebook, you also need to install jupyter
 ```
-(my_env) $ python -m pip install jupyterlab
+(my_env) $ pip install jupyter notebook
 ```
+See [example notebook](https://github.com/jpdeleon/quicklook/blob/main/notebook/examples.ipynb).
+
+## Try it on Google colab
+
+<a href="https://colab.research.google.com/github/jpdeleon/quicklook/blob/main/notebook/examples.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
 
 ## Command line script
 ```bash
@@ -37,7 +36,7 @@ Notes:
 * use single hyphen (-flag) if no value is needed.
 * use double hyphen (--flag value) if value is needed.
 
-Example: ql --name TOI-1234 --sector 27 -save -verbose
+Example: ql --name TOI-5071 --sector 46 -save -verbose
 
 options:
   -h, --help            show this help message and exit
@@ -75,12 +74,12 @@ options:
 
 ## Examples
 
-1. Run `quicklook` on the most recent TESS lightcurve of TOI 5071 (aka K2-100).
+1. Run `quicklook` on the most recent TESS lightcurve of TOI-5071 (aka K2-100).
 
 ```shell
 (my_env) $ ql --name TOI-5071
 ```
-![img](tests/k2-100_s46_pdcsap_sc.png)
+![img](tests/TOI5071_s46_pdcsap_sc.png)
 
 The figure above shows 9 panels. Let's break them down.
 * top row
@@ -98,7 +97,7 @@ The figure above shows 9 panels. Let's break them down.
 
 Try changing the parameters:
 ```shell
-(my_env) $ ql --name TIC52368076 -verbose -save | tee output.log
+(my_env) $ ql --name TIC-52368076 -verbose -save | tee output.log
 (my_env) $ ql --name TOI-125.01 --pipeline qlp #specific pipeline
 (my_env) $ ql --name TOI-125.01 --sector 2 #specific TESS sector
 (my_env) $ ql --name TOI-125.01 --flatten_method cosine #specific function to detrend baseline
@@ -107,10 +106,10 @@ Try changing the parameters:
 
 ## Advanced usage
 
-If you would like to run `ql` on a list of TIC IDs (saved as `tic_ids.txt`), then you can make a batch script named `run_ql_given_tic.batch`. The output files containing the plots (*.png) and periodogram results (*_tls.h5) will be saved in `tic_dir` directory:
+If you would like to run `ql` on a list of TIC IDs (saved as `tic_ids.txt`), then you can make a batch script named `run_ql_given_tic.batch`. The output files containing the logs (*.log), plots (*.png), and periodogram results (*_tls.h5) will be saved in `tic_dir` directory:
 
 ```shell
-(my_env) $ cat tic_ids.txt | while read tic; do echo ql --name TIC$tic -save --outdir tic_dir > TIC$tic.log 2>&1; done > run_ql_given_tic.batch
+(my_env) $ cat tic_ids.txt | while read tic; do echo ql --name TIC$tic -save --outdir tic_dir | tee TIC$tic.log; done > run_ql_given_tic.batch
 ```
 
 To test the Nth line of the batch script,

{quicklook_package-1.1.2 → quicklook_package-1.2}/quicklook/tql.py

@@ -80,41 +80,11 @@ class TessQuickLook:
     ):
         # start timer
         self.timer_start = timer()
-        self.verbose = verbose
         self.target_name = target_name
-        logger.info(f"Generating TQL for {self.target_name}...")
+        logger.info(f"Generating quicklook for {self.target_name}...")
+        self.verbose = verbose
         self.tfop_info = get_tfop_info(target_name)
-        self.star_names = np.array(
-            self.tfop_info.get("basic_info")["star_names"].split(", ")
-        )
-        if self.verbose:
-            print(f"Catalog names:")
-            for n in self.star_names:
-                print(f"\t{n}")
-        self.gaia_name = self.star_names[
-            np.array([i[:4].lower() == "gaia" for i in self.star_names])
-        ][0]
-        self.gaiaid = int(self.gaia_name.split()[-1])
-        ra, dec = (
-            self.tfop_info.get("coordinates")["ra"],
-            self.tfop_info.get("coordinates")["dec"],
-        )
-        self.target_coord = SkyCoord(ra=ra, dec=dec, unit="degree")
-
-        if target_name.lower()[:3] == "toi":
-            toiid = int(float(target_name.split("-")[-1]))
-        else:
-            idx = [i[:3].lower() == "toi" for i in self.star_names]
-            if sum(idx) > 0:
-                toiid = int(self.star_names[idx][0].split("-")[-1])
-            else:
-                toiid = None
-        self.toiid = toiid
-        self.ticid = int(self.tfop_info.get("basic_info")["tic_id"])
-        if self.ticid is not None:
-            self.query_name = f"TIC{self.ticid}"
-        else:
-            self.query_name = self.target_name.replace("-", " ")
+        self.parse_tfop_info()
         self.simbad_obj_type = self.get_simbad_obj_type()
         self.flux_type = flux_type
         self.exptime = exptime
@@ -135,49 +105,8 @@ class TessQuickLook:
         )
         self.gp_kernel_size = gp_kernel_size
         self.edge_cutoff = edge_cutoff
-        if custom_ephem:
-            self.ephem_source = "custom"
-            err_msg = (
-                "Custom ephem must be a tuple: (t0,t0err,P,Perr,t14,t14err)"
-            )
-            if len(custom_ephem) != 6:
-                logger.error(f"Error: {err_msg}")
-                sys.exit()
-            if self.verbose:
-                print(
-                    f"Using ephemeris mask:\nP={custom_ephem[0]}d\nt0={custom_ephem[2]}BJD\nt14={custom_ephem[4]}d"
-                )
-            # TODO: using tfop in variable name is misleading
-            if custom_ephem[0] > TESS_TIME_OFFSET:
-                if self.verbose:
-                    print(
-                        "Custom transit epoch given in JD. Converting to BTJD = JD-{TESS_TIME_OFFSET:,}."
-                    )
-                custom_ephem[0] -= TESS_TIME_OFFSET
-            self.tfop_epoch = (custom_ephem[0], custom_ephem[1])
-            self.tfop_period = (custom_ephem[2], custom_ephem[3])
-            if custom_ephem[4] > 1:
-                if self.verbose:
-                    print(
-                        "Custom transit duration given in hours. Converting to days."
-                    )
-                custom_ephem[4] /= 24
-                custom_ephem[5] /= 24
-            self.tfop_dur = (custom_ephem[4], custom_ephem[5])
-            self.tfop_depth = None
-        else:
-            # use tfop ephem if available
-            (
-                self.tfop_epoch,
-                self.tfop_period,
-                self.tfop_dur,
-                self.tfop_depth,
-            ) = (
-                self.get_toi_ephem()
-                if len(self.tfop_info.get("planet_parameters")) != 0
-                else (None, None, None, None)
-            )
-            self.ephem_source = "tfop" if self.tfop_epoch[0] else None
+        self.custom_ephem = custom_ephem
+        self.parse_custom_ephem()
 
         if window_length is None:
             self.window_length = (
@@ -191,13 +120,13 @@ class TessQuickLook:
 
         self.tmask = self.get_transit_mask()
         err_msg = "No masked transits"
-        if self.tmask.sum() == 0:
+        if self.tfop_epoch is not None and self.tmask.sum() == 0:
             logger.error(f"Error: {err_msg}")
             sys.exit()
         if mask_ephem:
             if self.verbose:
                 logger.info(
-                    f"Masking transits in raw lightcurve using {self.ephem_source} ephem."
+                    f"Masking transits in raw lightcurve using {self.ephem_source} ephem..."
                 )
             self.raw_lc = self.raw_lc[~self.tmask]
             # update tmask
@@ -258,6 +187,90 @@ class TessQuickLook:
         args = ", ".join(args)
         return f"{type(self).__name__}({args})"
 
+    def parse_tfop_info(self):
+        """
+        Parse the TFOP info to get the star names, Gaia name, Gaia ID, and target coordinates.
+        """
+        self.star_names = np.array(
+            self.tfop_info.get("basic_info")["star_names"].split(", ")
+        )
+        if self.verbose:
+            print(f"Catalog names:")
+            for n in self.star_names:
+                print(f"\t{n}")
+        self.gaia_name = self.star_names[
+            np.array([i[:4].lower() == "gaia" for i in self.star_names])
+        ][0]
+        self.gaiaid = int(self.gaia_name.split()[-1])
+        ra, dec = (
+            self.tfop_info.get("coordinates")["ra"],
+            self.tfop_info.get("coordinates")["dec"],
+        )
+        self.target_coord = SkyCoord(ra=ra, dec=dec, unit="degree")
+
+        if self.target_name.lower()[:3] == "toi":
+            self.toiid = int(float(self.target_name.split("-")[-1]))
+        else:
+            idx = [i[:3].lower() == "toi" for i in self.star_names]
+            if sum(idx) > 0:
+                toiid = int(self.star_names[idx][0].split("-")[-1])
+            else:
+                toiid = None
+            self.toiid = toiid
+        self.ticid = int(self.tfop_info.get("basic_info")["tic_id"])
+        if self.ticid is not None:
+            self.query_name = f"TIC{self.ticid}"
+        else:
+            self.query_name = self.target_name.replace("-", " ")
+
+    def parse_custom_ephem(self):
+        """
+        Parse the custom ephem to get the ephemeris source and parameters.
+        """
+        if self.custom_ephem:
+            self.ephem_source = "custom"
+            err_msg = (
+                "Custom ephem must be a tuple: (t0,t0err,P,Perr,t14,t14err)"
+            )
+            if len(self.custom_ephem) != 6:
+                logger.error(f"Error: {err_msg}")
+                sys.exit()
+            if self.verbose:
+                logger.info(
+                    f"Using ephemeris mask:\nP={self.custom_ephem[0]}d\nt0={self.custom_ephem[2]}BJD\nt14={self.custom_ephem[4]}d"
+                )
+            # TODO: using tfop in variable name is misleading
+            if self.custom_ephem[0] > TESS_TIME_OFFSET:
+                if self.verbose:
+                    logger.info(
+                        "Custom transit epoch given in JD. Converting to BTJD = JD-{TESS_TIME_OFFSET:,}."
+                    )
+                self.custom_ephem[0] -= TESS_TIME_OFFSET
+            self.tfop_epoch = (self.custom_ephem[0], self.custom_ephem[1])
+            self.tfop_period = (self.custom_ephem[2], self.custom_ephem[3])
+            if self.custom_ephem[4] > 1:
+                if self.verbose:
+                    logger.info(
+                        "Custom transit duration given in hours. Converting to days."
+                    )
+                self.custom_ephem[4] /= 24
+                self.custom_ephem[5] /= 24
+            self.tfop_dur = (self.custom_ephem[4], self.custom_ephem[5])
+            self.tfop_depth = None
+        else:
+            # use tfop ephem if available
+            (
+                self.tfop_epoch,
+                self.tfop_period,
+                self.tfop_dur,
+                self.tfop_depth,
+            ) = (
+                self.get_toi_ephem()
+                if len(self.tfop_info.get("planet_parameters")) != 0
+                else (None, None, None, None)
+            )
+            self.ephem_source = "tfop" if self.tfop_epoch is not None else None
+
     def check_file_exists(self):
         name = self.target_name.replace(" ", "")
         if name.lower()[:3] == "toi":
@@ -361,7 +374,7 @@ class TessQuickLook:
             sector_orig = None
         else:
             sector_orig = kwargs.pop("sector")
-            sector = None if sector_orig in ["all", -1] else sector_orig
+            sector = None if sector_orig in ["all", -1] else int(sector_orig)
             kwargs["sector"] = sector
 
         if sector_orig == "all":
@@ -423,6 +436,9 @@ class TessQuickLook:
             if self.verbose:
                 print(f"Filtered lightcurves based on query ({kwargs}):")
                 print(search_result.table.to_pandas()[cols])
+            msg = f"Downloading all {kwargs.get('author')} lcs..."
+            if self.verbose:
+                logger.info(msg)
             filtered_sectors = self.get_unique_sectors(search_result)
             if len(filtered_sectors) <= 1:
                 logger.error(
@@ -430,17 +446,20 @@ class TessQuickLook:
                 )
                 sys.exit()
             lc = search_result.download_all().stitch()
-            msg = f"Downloaded all {kwargs.get('author')} lc in sectors {', '.join([str(s) for s in self.all_sectors])}."
+            self.sector = self.all_sectors
+            exptime = int(lc.meta["EXPOSURE"] / 10) * 10
+            msg = f"Downloaded all {kwargs.get('author')} (exp={exptime} s) lcs in sectors {', '.join([str(s) for s in self.all_sectors])}."
             if self.verbose:
                 logger.info(msg)
-            exptime = int(lc.meta["EXPOSURE"] / 10) * 10
-            self.sector = self.all_sectors
         else:
             # Download the light curve for the specified sector
+            msg = f"Downloading {kwargs.get('author').upper()} lc..."
+            if self.verbose:
+                logger.info(msg)
             idx = sector_orig if sector_orig == -1 else 0
             lc = search_result[idx].download()
-            exptime = search_result.exptime[idx].value
-            msg = f"Downloaded {kwargs.get('author').upper()} (exp={exptime} s) lc in sector {lc.sector}."
+            exptime = int(lc.meta["EXPOSURE"] / 10) * 10
+            msg = f"Downloaded {lc.meta['AUTHOR'].upper()} (exp={exptime} s) lc in sector {lc.sector}."
             if self.verbose:
                 logger.info(msg)
             self.sector = lc.sector
@@ -452,6 +471,7 @@ class TessQuickLook:
         # Set exposure time and cadence
         if self.exptime is None:
             self.exptime = exptime
+        # assert self.exptime == search_result.exptime[idx].value
         self.cadence = "short" if self.exptime < 1800 else "long"
 
         # Apply sigma clipping if specified
@@ -491,7 +511,7 @@ class TessQuickLook:
             sector_orig = None
         else:
             sector_orig = kwargs.pop("sector")
-            sector = None if sector_orig in ["all", -1] else sector_orig
+            sector = None if sector_orig in ["all", -1] else int(sector_orig)
             kwargs["sector"] = sector
 
         if kwargs.get("author") is None:
@@ -520,7 +540,7 @@ class TessQuickLook:
                 tpf_authors[i] for i in range(len(tpf_authors)) if i != "QLP"
             ][0]
         if self.verbose:
-            logger.info(f"Using {kwargs.get('author').upper()} TPF.")
+            logger.info(f"Using {kwargs.get('author').upper()} TPF...")
 
         # Search using the specified author and sector
         search_result = lk.search_targetpixelfile(self.query_name, **kwargs)
@@ -529,13 +549,16 @@ class TessQuickLook:
         if len(search_result) == 0:
             logger.error(f"Error: {err_msg}")
             sys.exit()
+        msg = f"Downloading TPF..."
+        if self.verbose:
+            logger.info(msg)
         idx = sector_orig if sector_orig == -1 else 0
         tpf = search_result[idx].download()
         # FIXME: What is the correct tpf aperture for other pipeline?
         # author = tpf.meta['PROCVER'].split('-')[0]
         author = search_result.author[idx].upper()
         exptime = search_result.exptime[idx].value
-        msg = f"Downloaded {author.upper()} (exp={exptime} s) TPF "
+        msg = f"Downloaded {author} (exp={exptime} s) TPF "
         msg += f"in sector {tpf.meta['SECTOR']}."
         if self.verbose:
             logger.info(msg)
@@ -673,7 +696,7 @@ class TessQuickLook:
         )
         if self.verbose:
             logger.info(
-                "Estimating rotation period using Generalized Lomb-Scargle (GLS) periodogram."
+                "Estimating rotation period using Generalized Lomb-Scargle (GLS) periodogram..."
             )
         return Gls(
             data, Pbeg=self.Porb_min, Pend=self.Porb_max, verbose=self.verbose
@@ -790,7 +813,7 @@ class TessQuickLook:
             try:
                 # Convert to float or int as needed
                 params[name] = (
-                    int(star_params.get(name))
+                    int(float(star_params.get(name)))
                     if name == "teff"
                     else float(star_params.get(name))
                 )
@@ -1004,11 +1027,9 @@ class TessQuickLook:
         self.trend_lc.plot(ax=ax, color="r", lw=2, label="trend")
 
         if self.verbose:
-            logger.info("Plotting Lomb-Scargle periodogram...")
+            logger.info("Running Lomb-Scargle periodogram...")
         ax = axes.flatten()[1]
         if self.pg_method == "gls":
-            if self.verbose:
-                logger.info("Initializing GLS...")
             self.gls = self.init_gls()
             ax = plot_gls_periodogram(
                 self.gls,
@@ -1023,7 +1044,7 @@ class TessQuickLook:
             self.Prot_ls = self.gls.best["P"]
             if math.isnan(self.gls.power.max()):
                 logger.error(
-                    "GLS power max is NaN, switching to Lomb-Scargle..."
+                    "GLS power is NaN, switching to astropy's Lomb-Scargle..."
                 )
                 ax.clear()
                 self.pg_method = "lombscargle"
@@ -1035,8 +1056,6 @@ class TessQuickLook:
                 )
                 self.Prot_ls = pg.period_at_max_power.value
         else:
-            if self.verbose:
-                logger.info(f"Using periodogram method: {self.pg_method}...")
             self.gls = None
             pg = plot_periodogram(
                 self.raw_lc[~self.tmask],
@@ -1045,7 +1064,6 @@ class TessQuickLook:
                 ax=ax,
             )
             self.Prot_ls = pg.period_at_max_power.value
-
         if self.verbose:
             logger.info("Appending TLS results...")
         self.append_tls_results()
@@ -1125,8 +1143,6 @@ class TessQuickLook:
             self.tpf = self.get_tpf_tesscut()
             self.sap_mask = "square"
         else:
-            if self.verbose:
-                logger.info("Getting TPF...")
             self.tpf = self.get_tpf(
                 sector=self.sector,
                 author=self.pipeline,
@@ -1204,13 +1220,13 @@ class TessQuickLook:
         title = ""
         if self.toiid is not None:
             title = f"TOI {self.toiid} | "
-        title += f"TIC {self.ticid} "
+        title += f"TIC {self.ticid} | sector {self.sector} | "
         lctype = (
             f"{self.pipeline.upper()}/{self.flux_type}"
             if self.pipeline == "spoc"
             else self.pipeline.upper()
         )
-        title += f"| {lctype} lightcurve"
+        title += f"{lctype.upper()} lightcurve"
         fig.suptitle(title, y=1.0, fontsize=20)
 
         if (self.outdir is not None) & (not Path(self.outdir).exists()):

{quicklook_package-1.1.2 → quicklook_package-1.2/quicklook_package.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quicklook-package
-Version: 1.1.2
+Version: 1.2
 Summary: Quicklook lightcurve plot generator
 Home-page: https://github.com/jpdeleon/quicklook
 Author-email: jpdeleon <jpdeleon.bsap@gmail.com>
@@ -25,30 +25,29 @@ Requires-Dist: astroplan==0.9
 Requires-Dist: loguru
 
 # QuickLook
-`quicklook` is a Python program that runs a simple pipeline to search for transit signal in TESS (and Kepler soon) light curves. This program can be run in a jupyter notebook (see [example](https://github.com/jpdeleon/quicklook/tree/main/notebook)) or from the terminal using the `ql` script.
+`quicklook` is a Python program that runs a simple pipeline to search for transit signal in TESS (and Kepler soon) light curves. This program can be run in a jupyter notebook or from the terminal using the `ql` script.
 
 ## Use case
 Given target name, run periodograms on a TESS or Kepler lightcurve (if it exists) to measure the stellar rotation period and the orbital period of a potential companion i.e. planet, brown dwarf, or star.
 Although `quicklook` is optimized to find transiting exoplanets, this tool can also find eclipsing binaries and many other periodic signals.
 
-## Try it on Google colab
-
-<a href="https://colab.research.google.com/github/jpdeleon/quicklook/blob/main/notebook/examples.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
-
-
 ## Installation
-Create a conda environment called, say `my_env`, and install there an editable version of `quicklook`
+Create a conda environment called, say `my_env`, and install there the latest version of `quicklook-package`
 ```bash
 $ conda create -n my_env python=3.10
 $ conda activate my_env
-(my_env) $ python -m python -m pip install -r https://raw.githubusercontent.com/jpdeleon/quicklook/main/requirements.txt
-(my_env) $ python -m pip install -e git+https://github.com/jpdeleon/quicklook.git#egg=quicklook
+(my_env) $ pip install -U quicklook-package
 ```
 
-If you want to run `quicklook` in a notebook, you also need to install jupyter
+If you want to run `quicklook` locally in a notebook, you also need to install jupyter
 ```
-(my_env) $ python -m pip install jupyterlab
+(my_env) $ pip install jupyter notebook
 ```
+See [example notebook](https://github.com/jpdeleon/quicklook/blob/main/notebook/examples.ipynb).
+
+## Try it on Google colab
+
+<a href="https://colab.research.google.com/github/jpdeleon/quicklook/blob/main/notebook/examples.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
 
 ## Command line script
 ```bash
@@ -63,7 +62,7 @@ Notes:
 * use single hyphen (-flag) if no value is needed.
 * use double hyphen (--flag value) if value is needed.
 
-Example: ql --name TOI-1234 --sector 27 -save -verbose
+Example: ql --name TOI-5071 --sector 46 -save -verbose
 
 options:
   -h, --help            show this help message and exit
@@ -101,12 +100,12 @@ options:
 
 ## Examples
 
-1. Run `quicklook` on the most recent TESS lightcurve of TOI 5071 (aka K2-100).
+1. Run `quicklook` on the most recent TESS lightcurve of TOI-5071 (aka K2-100).
 
 ```shell
 (my_env) $ ql --name TOI-5071
 ```
-![img](tests/k2-100_s46_pdcsap_sc.png)
+![img](tests/TOI5071_s46_pdcsap_sc.png)
 
 The figure above shows 9 panels. Let's break them down.
 * top row
@@ -124,7 +123,7 @@ The figure above shows 9 panels. Let's break them down.
 
 Try changing the parameters:
 ```shell
-(my_env) $ ql --name TIC52368076 -verbose -save | tee output.log
+(my_env) $ ql --name TIC-52368076 -verbose -save | tee output.log
 (my_env) $ ql --name TOI-125.01 --pipeline qlp #specific pipeline
 (my_env) $ ql --name TOI-125.01 --sector 2 #specific TESS sector
 (my_env) $ ql --name TOI-125.01 --flatten_method cosine #specific function to detrend baseline
@@ -133,10 +132,10 @@ Try changing the parameters:
 
 ## Advanced usage
 
-If you would like to run `ql` on a list of TIC IDs (saved as `tic_ids.txt`), then you can make a batch script named `run_ql_given_tic.batch`. The output files containing the plots (*.png) and periodogram results (*_tls.h5) will be saved in `tic_dir` directory:
+If you would like to run `ql` on a list of TIC IDs (saved as `tic_ids.txt`), then you can make a batch script named `run_ql_given_tic.batch`. The output files containing the logs (*.log), plots (*.png), and periodogram results (*_tls.h5) will be saved in `tic_dir` directory:
 
 ```shell
-(my_env) $ cat tic_ids.txt | while read tic; do echo ql --name TIC$tic -save --outdir tic_dir > TIC$tic.log 2>&1; done > run_ql_given_tic.batch
+(my_env) $ cat tic_ids.txt | while read tic; do echo ql --name TIC$tic -save --outdir tic_dir | tee TIC$tic.log; done > run_ql_given_tic.batch
 ```
 
 To test the Nth line of the batch script,

{quicklook_package-1.1.2 → quicklook_package-1.2}/setup.py

@@ -10,7 +10,7 @@ with open("requirements.txt") as f:
 # see pyproject.toml for details such as version and requirements
 setup(
     name="quicklook-package",
-    version="1.1.2",
+    version="1.2",
     description="Quicklook lightcurve plot generator",
     long_description=long_description,
     long_description_content_type="text/markdown",

quicklook_package-1.2/tests/test_tql.py

@@ -0,0 +1,39 @@
+import pytest
+from quicklook.tql import TessQuickLook
+from matplotlib.figure import Figure
+
+
+@pytest.fixture
+def planet_inputs():
+    # Provide sample data for testing
+    return {
+        "target_name": "WASP-21",
+        "sector": 56,
+        "flux_type": "pdcsap",
+        "pipeline": "SPOC",
+    }
+
+
+def test_tql_planet(planet_inputs):
+    ql = TessQuickLook(**planet_inputs)
+    assert isinstance(ql, TessQuickLook)
+    fig = ql.plot_tql()
+    assert isinstance(fig, Figure)
+
+
+@pytest.fixture
+def eb_inputs():
+    # Provide sample data for testing
+    return {
+        "target_name": "TIC 144539611",
+        "sector": 4,
+        "flux_type": "pdcsap",
+        "pipeline": "SPOC",
+    }
+
+
+def test_tql_eb(eb_inputs):
+    ql = TessQuickLook(**eb_inputs)
+    assert isinstance(ql, TessQuickLook)
+    fig = ql.plot_tql()
+    assert isinstance(fig, Figure)

quicklook_package-1.1.2/tests/test_tql.py

@@ -1,21 +0,0 @@
-import pytest
-from quicklook.tql import TessQuickLook
-from matplotlib.figure import Figure
-
-
-@pytest.fixture
-def sample_inputs():
-    # Provide sample data for testing
-    return {
-        "target_name": "WASP-21",
-        "sector": 56,
-        "flux_type": "pdcsap",
-        "pipeline": "SPOC",
-    }
-
-
-def test_tql(sample_inputs):
-    ql = TessQuickLook(**sample_inputs)
-    assert isinstance(ql, TessQuickLook)
-    fig = ql.plot_tql()
-    assert isinstance(fig, Figure)