Merge pull request #45 from spacesys-finch/dev

Dev

.pre-commit-config.yaml

@@ -10,8 +10,14 @@ repos:
   - id: black
     language_version: python3.9
 
+- repo: https://github.com/myint/docformatter
+  rev: v1.4
+  hooks:
+    - id: docformatter
+      args: [--blank, --in-place, --recursive, --wrap-descriptions=70, --wrap-summaries=80]
+
 - repo: https://github.com/pycqa/pylint
   rev: v2.12.2
   hooks:
   - id: pylint
-    additional_dependencies: [pytest, numpy, plotly]
+    additional_dependencies: [pytest, numpy, plotly, scipy]

README.md

@@ -121,12 +121,13 @@ This repo is configured to use [pre-commit](https://pre-commit.com/) hooks. The
 
 1. [Isort](https://pycqa.github.io/isort/): Sorts imports, so you don't have to.
 1. [Black](https://black.readthedocs.io/en/stable/): The uncompromising code autoformatter.
+1. [Docformatter](https://github.com/myint/docformatter): A docstring autoformatter.
 1. [Pylint](https://github.com/pycqa/pylint): It's not just a linter that annoys you!
 
 Pre-commit will run the hooks on commit, but when a hook fails, they can be run manually to delint using:
 
 ```
-isort . & black . & pylint_runner
+pre-commit run --all-files
 ```
 
 ### Branches

data/atmos_radiance_max_config.txt

@@ -0,0 +1,45 @@
+---------------- GENERAL PARAMETERS ----------------
+Print Config: True 
+Background: False 
+Decibels: False 
+
+---------------- SIGNAL PARAMETERS ----------------
+Fore Optics Transmittance: 0.8 
+Collimator Transmittance: 0.8 
+Filter Transmittance: 0.9 
+Diverging Lens Transmittance: 0.8 
+X Pixels: 640 
+Y Pixels: 512 
+Pixel Pitch: 15 um
+Integration Time: 0.1667 s
+Focal Length: 200 
+Aperture Diameter: 33 mm
+Fraction of Aperture Blocked: 0.922 
+Planck Constant: 6.63e-34 Js
+Speed of Light: 300000000.0 m/s
+Sensor: flirtau 
+Diffraction Grating: wasatch900 
+
+---------------- NOISE PARAMETERS ----------------
+Well Depth: 19000 e-/pixel
+Dynamic Range: 14 bit
+Dark Current: 10 e-/pixel/second
+Readout Noise: 500 e-/pixel
+
+---------------- FILE PATHS ----------------
+ChromeDriver path: C:/Users/adynxps/Downloads/chromedriver_win32_95/chromedriver.exe 
+Orbital Parameters CSV Path: ./Modtran_Graphs/modtran_orbit_params.csv 
+Output Plots Path: snr_results 
+
+---------------- MODTRAN PARAMETERS ----------------
+Spectral Resolution: 1.0 nm
+Spectral Range Lower Bound: 900 nm
+Spectral Range Upper Bound: 1700 nm
+Season: fall 
+Carbon Dioxide: 419.05 ppmv
+Carbon Monoxide: 0.1575 ppmv
+Methane: 1.879 ppmv
+Aerosol Model: urban 
+Visibility: 23.0 km
+Spectral Units: microns 
+Save Plots: False 

data/atmos_radiance_min_config.txt

@@ -0,0 +1,45 @@
+---------------- GENERAL PARAMETERS ----------------
+Print Config: True 
+Background: False 
+Decibels: False 
+
+---------------- SIGNAL PARAMETERS ----------------
+Fore Optics Transmittance: 0.8 
+Collimator Transmittance: 0.8 
+Filter Transmittance: 0.9 
+Diverging Lens Transmittance: 0.8 
+X Pixels: 640 
+Y Pixels: 512 
+Pixel Pitch: 15 um
+Integration Time: 0.1667 s
+Focal Length: 200 
+Aperture Diameter: 33 mm
+Fraction of Aperture Blocked: 0.922 
+Planck Constant: 6.63e-34 Js
+Speed of Light: 300000000.0 m/s
+Sensor: flirtau 
+Diffraction Grating: wasatch900 
+
+---------------- NOISE PARAMETERS ----------------
+Well Depth: 19000 e-/pixel
+Dynamic Range: 14 bit
+Dark Current: 10 e-/pixel/second
+Readout Noise: 500 e-/pixel
+
+---------------- FILE PATHS ----------------
+ChromeDriver path: C:/Users/adynxps/Downloads/chromedriver_win32_95/chromedriver.exe 
+Orbital Parameters CSV Path: ./Modtran_Graphs/modtran_orbit_params.csv 
+Output Plots Path: snr_results 
+
+---------------- MODTRAN PARAMETERS ----------------
+Spectral Resolution: 1.0 nm
+Spectral Range Lower Bound: 900 nm
+Spectral Range Upper Bound: 1700 nm
+Season: summer 
+Carbon Dioxide: 419.05 ppmv
+Carbon Monoxide: 0.1575 ppmv
+Methane: 1.879 ppmv
+Aerosol Model: urban 
+Visibility: 23.0 km
+Spectral Units: microns 
+Save Plots: False