isort

Author: yoachim

doc/conf.py

@@ -3,7 +3,6 @@
 from typing import List
 
 import lsst_sphinx_bootstrap_theme
-
 from documenteer.sphinxconfig.utils import form_ltd_edition_name
 
 # Work around Sphinx bug related to large and highly-nested source files
@@ -43,9 +42,7 @@
 
 # General information about the project.
 project = "rubin_sim"
-copyright = (
-    "2015-2022 " "Association of Universities for Research in Astronomy, Inc. (AURA)"
-)
+copyright = "2015-2022 " "Association of Universities for Research in Astronomy, Inc. (AURA)"
 author = "LSST Survey Strategy Team"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -57,9 +54,7 @@
     release = version
 else:
     # Use branch name as the version tag
-    version = form_ltd_edition_name(
-        git_ref_name=os.getenv("TRAVIS_BRANCH", default="main")
-    )
+    version = form_ltd_edition_name(git_ref_name=os.getenv("TRAVIS_BRANCH", default="main"))
     release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation

doc/metric_list.py

@@ -1,6 +1,7 @@
 import inspect
-import rubin_sim.maf.metrics as metrics
+
 import rubin_sim.maf.maf_contrib as maf_contrib
+import rubin_sim.maf.metrics as metrics
 
 __all__ = ["make_metric_list"]
 
@@ -35,9 +36,7 @@ def make_metric_list(outfile):
     for name, obj in inspect.getmembers(maf_contrib):
         if inspect.isclass(obj):
             modname = inspect.getmodule(obj).__name__
-            if modname.startswith("rubin_sim.maf.maf_contrib") and name.endswith(
-                "Metric"
-            ):
+            if modname.startswith("rubin_sim.maf.maf_contrib") and name.endswith("Metric"):
                 link = f":py:class:`~rubin_sim.maf.maf_contrib.{name}` "
                 simpledoc = inspect.getdoc(obj).split("\n")[0]
                 print(f"- {link} \n \t {simpledoc}", file=f)

pyproject.toml

@@ -64,3 +64,52 @@ asyncio_mode = "auto"
 disallow_untyped_defs = "True"
 ignore_missing_imports = "True"
 exclude = "version.py"
+
+[tool.black]
+line-length = 110
+target-version = ["py310"]
+
+[tool.isort]
+profile = "black"
+line_length = 110
+
+[tool.ruff]
+exclude = [
+    "__init__.py",
+]
+ignore = [
+    "N802",
+    "N803",
+    "N806",
+    "N812",
+    "N815",
+    "N816",
+    "N999",
+    "D107",
+    "D105",
+    "D102",
+    "D104",
+    "D100",
+    "D200",
+    "D205",
+    "D400",
+]
+line-length = 110
+select = [
+    "E",  # pycodestyle
+    "F",  # pyflakes
+    "N",  # pep8-naming
+    "W",  # pycodestyle
+    #"D",  # pydocstyle
+]
+target-version = "py310"
+extend-select = [
+    "RUF100", # Warn about unused noqa
+]
+
+[tool.ruff.pycodestyle]
+max-doc-length = 79
+
+[tool.ruff.pydocstyle]
+convention = "numpy"
+

rubin_sim/data/data_sets.py

@@ -1,8 +1,7 @@
+import glob
 import os
-import warnings
 import subprocess
-import glob
-
+import warnings
 
 __all__ = ["get_data_dir", "data_versions", "get_baseline"]
 

rubin_sim/data/rs_download_data.py

@@ -1,18 +1,17 @@
 #!/usr/bin/env python
+import argparse
 import os
 import warnings
+from shutil import rmtree, unpack_archive
+
 import requests
 from requests.exceptions import ConnectionError
-import argparse
 from tqdm.auto import tqdm
-from shutil import unpack_archive, rmtree
 
-from .data_sets import get_data_dir, data_versions
+from .data_sets import data_versions, get_data_dir
 
 DEFAULT_DATA_URL = "https://s3df.slac.stanford.edu/data/rubin/sim-data/rubin_sim_data/"
-BACKUP_DATA_URL = (
-    "https://epyc.astro.washington.edu/~lynnej/opsim_downloads/rubin_sim_data/"
-)
+BACKUP_DATA_URL = "https://epyc.astro.washington.edu/~lynnej/opsim_downloads/rubin_sim_data/"
 
 
 def data_dict():
@@ -42,9 +41,7 @@ def rs_download_data():
     """Download data."""
 
     files = data_dict()
-    parser = argparse.ArgumentParser(
-        description="Download data files for rubin_sim package"
-    )
+    parser = argparse.ArgumentParser(description="Download data files for rubin_sim package")
     parser.add_argument(
         "--versions",
         dest="versions",
@@ -132,9 +129,7 @@ def rs_download_data():
     print(f"Could not connect to {args.url_base}; trying {url_base}")
     try:
         r = requests.get(url_base)
-        fail_message = (
-            f"Could not connect to {args.url_base} or {url_base}. Check sites are up?"
-        )
+        fail_message = f"Could not connect to {args.url_base} or {url_base}. Check sites are up?"
     except ConnectionError:
         print(fail_message)
         exit()
@@ -150,9 +145,7 @@ def rs_download_data():
         else:
             if os.path.isdir(path) and args.force:
                 rmtree(path)
-                warnings.warn(
-                    "Removed existing directory %s, downloading new copy" % path
-                )
+                warnings.warn("Removed existing directory %s, downloading new copy" % path)
             # Download file
             url = url_base + filename
             print("Downloading file: %s" % url)
@@ -161,12 +154,8 @@ def rs_download_data():
             file_size = int(r.headers.get("Content-Length", 0))
             if file_size < 245:
                 warnings.warn(f"{url} file size unexpectedly small.")
-            block_size = (
-                1024 * 1024
-            )  # download this size chunk at a time; reasonable guess
-            progress_bar = tqdm(
-                total=file_size, unit="iB", unit_scale=True, disable=args.tdqm_disable
-            )
+            block_size = 1024 * 1024  # download this size chunk at a time; reasonable guess
+            progress_bar = tqdm(total=file_size, unit="iB", unit_scale=True, disable=args.tdqm_disable)
             print(f"Writing to {os.path.join(data_dir, filename)}")
             with open(os.path.join(data_dir, filename), "wb") as f:
                 for chunk in r.iter_content(chunk_size=block_size):

rubin_sim/data/rs_download_sky.py

@@ -1,9 +1,10 @@
 #!/usr/bin/env python
-import os
-import requests
 import argparse
+import os
 from html.parser import HTMLParser
 
+import requests
+
 from . import get_data_dir
 
 

rubin_sim/maf/__init__.py

@@ -21,15 +21,15 @@
 #
 """Python interface to the metrics analysis framework.
 """
+from .batches import *
 from .db import *
+from .maf_contrib import *
+from .maps import *
+from .metric_bundles import *
 from .metrics import *
+from .plots import *
+from .run_comparison import *
 from .slicers import *
 from .stackers import *
-from .metric_bundles import *
-from .maps import *
-from .plots import *
 from .utils import *
-from .batches import *
-from .run_comparison import *
 from .web import *
-from .maf_contrib import *

rubin_sim/maf/batches/__init__.py

@@ -1,17 +1,17 @@
+from .altaz_batch import *
 from .col_map_dict import *
 from .common import *
-from .slew_batch import *
-from .time_batch import *
-from .metadata_batch import *
-from .visitdepth_batch import *
-from .hourglass_batch import *
-from .glance_batch import *
+from .ddf_batch import *
 from .filterchange_batch import *
-from .openshutter_batch import *
-from .skycoverage import *
-from .altaz_batch import *
+from .glance_batch import *
+from .hourglass_batch import *
+from .info_batch import *
+from .metadata_batch import *
 from .moving_objects_batch import *
+from .openshutter_batch import *
 from .science_radar_batch import *
-from .ddf_batch import *
+from .skycoverage import *
+from .slew_batch import *
 from .srd_batch import *
-from .info_batch import *
+from .time_batch import *
+from .visitdepth_batch import *

rubin_sim/maf/batches/altaz_batch.py

@@ -1,7 +1,8 @@
-import rubin_sim.maf.metrics as metrics
-import rubin_sim.maf.slicers as slicers
 import rubin_sim.maf.metric_bundles as mb
+import rubin_sim.maf.metrics as metrics
 import rubin_sim.maf.plots as plots
+import rubin_sim.maf.slicers as slicers
+
 from .col_map_dict import col_map_dict
 from .common import filter_list
 
@@ -74,8 +75,7 @@ def altazHealpix(
             "group": "Alt/Az",
             "order": orders[f],
             "subgroup": subgroup,
-            "caption": "Pointing History on the alt-az sky (zenith center) for filter %s"
-            % f,
+            "caption": "Pointing History on the alt-az sky (zenith center) for filter %s" % f,
         }
         bundle = mb.MetricBundle(
             metric,

rubin_sim/maf/batches/common.py

@@ -1,4 +1,5 @@
 from __future__ import print_function
+
 import inspect
 
 import rubin_sim.maf.metrics as metrics
@@ -211,12 +212,8 @@ def extended_metrics(colname, replace_colname=None):
     extendedMetrics = standard_metrics(colname, replace_colname=None)
     extendedMetrics += [
         metrics.RmsMetric(colname),
-        metrics.NoutliersNsigmaMetric(
-            colname, metric_name="N(+3Sigma) " + colname, n_sigma=3
-        ),
-        metrics.NoutliersNsigmaMetric(
-            colname, metric_name="N(-3Sigma) " + colname, n_sigma=-3
-        ),
+        metrics.NoutliersNsigmaMetric(colname, metric_name="N(+3Sigma) " + colname, n_sigma=3),
+        metrics.NoutliersNsigmaMetric(colname, metric_name="N(-3Sigma) " + colname, n_sigma=-3),
         metrics.PercentileMetric(colname, percentile=25),
         metrics.PercentileMetric(colname, percentile=75),
         metrics.CountMetric(colname),
@@ -282,12 +279,8 @@ def summary_completeness_at_time(times, h_val, h_index=0.33):
     List of moving object MoCompletenessAtTime metrics (cumulative and differential)
     """
     summaryMetrics = [
-        metrics.MoCompletenessAtTimeMetric(
-            times=times, hval=h_val, hindex=h_index, cumulative=False
-        ),
-        metrics.MoCompletenessAtTimeMetric(
-            times=times, hval=h_val, hindex=h_index, cumulative=True
-        ),
+        metrics.MoCompletenessAtTimeMetric(times=times, hval=h_val, hindex=h_index, cumulative=False),
+        metrics.MoCompletenessAtTimeMetric(times=times, hval=h_val, hindex=h_index, cumulative=True),
     ]
     return summaryMetrics
 
@@ -308,12 +301,8 @@ def summary_completeness_over_h(requiredChances=1, Hindex=0.33):
     List of moving object MoCompleteness metrics (cumulative and differential)
     """
     summaryMetrics = [
-        metrics.MoCompletenessMetric(
-            threshold=requiredChances, cumulative=False, hindex=Hindex
-        ),
-        metrics.MoCompletenessMetric(
-            threshold=requiredChances, cumulative=True, hindex=Hindex
-        ),
+        metrics.MoCompletenessMetric(threshold=requiredChances, cumulative=False, hindex=Hindex),
+        metrics.MoCompletenessMetric(threshold=requiredChances, cumulative=True, hindex=Hindex),
     ]
     return summaryMetrics
 
@@ -357,12 +346,8 @@ def microlensing_summary(metric_type, npts_required=10, Fisher_sigmatE_tE_cutoff
             ),
             metrics.CountMetric(metric_name="Total lightcurves in footprint"),
             metrics.CountMetric(metric_name="Total lightcurves on sky", mask_val=0),
-            metrics.MeanMetric(
-                metric_name="Mean number of points per lightcurves in footprint"
-            ),
-            metrics.MeanMetric(
-                mask_val=0, metric_name="Mean number of points per lightcurves in total"
-            ),
+            metrics.MeanMetric(metric_name="Mean number of points per lightcurves in footprint"),
+            metrics.MeanMetric(mask_val=0, metric_name="Mean number of points per lightcurves in total"),
         ]
     elif metric_type == "Fisher":
         microlensingSummary = [
@@ -373,8 +358,6 @@ def microlensing_summary(metric_type, npts_required=10, Fisher_sigmatE_tE_cutoff
             metrics.CountMetric(metric_name="Total lightcurves in footprint"),
             metrics.CountMetric(metric_name="Total lightcurves on sky", mask_val=0),
             metrics.RealMeanMetric(metric_name="Mean sigma_tE/tE in footprint (mean)"),
-            metrics.RealMeanMetric(
-                mask_val=0, metric_name="Mean sigma_tE/tE of total (mean)"
-            ),
+            metrics.RealMeanMetric(mask_val=0, metric_name="Mean sigma_tE/tE of total (mean)"),
         ]
     return microlensingSummary