doc string with cloud type labels

NREL · Aug 22, 2024 · 8360ab4 · 8360ab4
1 parent 04a0905
commit 8360ab4
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/farms/__init__.py b/farms/__init__.py
@@ -1,16 +1,37 @@
 # -*- coding: utf-8 -*-
 """
 FARMS package
+
+Note:
+----
+cloud_types:
+    "'N/A': -15,
+    'Clear': 0,
+    'Probably Clear': 1,
+    'Fog': 2,
+    'Water': 3,
+    'Super-Cooled Water': 4,
+    'Mixed': 5,
+    'Opaque Ice': 6,
+    'Cirrus': 7,
+    'Overlapping': 8,
+    'Overshooting': 9,
+    'Unknown': 10,
+    'Dust': 11,
+    'Smoke': 12"
 """
+
 import os
+
 import pandas as pd
 
 from .version import __version__
 
 FARMSDIR = os.path.dirname(os.path.realpath(__file__))
 
 RADIUS = pd.read_csv(
-    os.path.join(FARMSDIR, 'sun_earth_radius_vector.csv')).set_index('doy')
+    os.path.join(FARMSDIR, "sun_earth_radius_vector.csv")
+).set_index("doy")
 
 # Constant clear/cloudy integer labels for use of AllSky
 CLEAR_TYPES = (0, 1, 11, 12)