Merge pull request #78 from equinor/nncrefactor

Remove superfluous wrapper in nnc

ecl2df/nnc.py

@@ -14,7 +14,7 @@
 from .grid import gridgeometry2df
 
 
-def nnc2df(eclfiles, coords=False, pillars=False):
+def df(eclfiles, coords=False, pillars=False):
     """Produce a Pandas Dataframe with NNC information
 
     A NNC is a pair of cells that are not next to each other
@@ -210,13 +210,8 @@ def nnc2df_main(args):
         logging.getLogger().setLevel(logging.INFO)
     logging.getLogger().name = "nnc2df"
     eclfiles = EclFiles(args.DATAFILE)
-    nncdf = nnc2df(eclfiles, coords=args.coords, pillars=args.pillars)
+    nncdf = df(eclfiles, coords=args.coords, pillars=args.pillars)
     if nncdf.empty:
         logging.warning("Empty NNC dataframe being written to disk!")
     nncdf.to_csv(args.output, index=False)
     print("Wrote to " + args.output)
-
-
-def df(eclfiles, coords=False, pillars=False):
-    """Main function for Python API users"""
-    return nnc2df(eclfiles, coords=coords, pillars=pillars)

tests/test_nnc.py

@@ -20,7 +20,7 @@
 def test_nnc2df():
     """Test that dataframes are produced"""
     eclfiles = EclFiles(DATAFILE)
-    nncdf = nnc.nnc2df(eclfiles)
+    nncdf = nnc.df(eclfiles)
 
     assert not nncdf.empty
     assert "I1" in nncdf
@@ -41,7 +41,7 @@ def test_nnc2df():
 def test_nnc2df_coords():
     """Test that we are able to add coordinates"""
     eclfiles = EclFiles(DATAFILE)
-    gnncdf = nnc.nnc2df(eclfiles, coords=True)
+    gnncdf = nnc.df(eclfiles, coords=True)
     assert not gnncdf.empty
     assert "X" in gnncdf
     assert "Y" in gnncdf
@@ -51,7 +51,7 @@ def test_nnc2df_coords():
 def test_nnc2df_faultnames():
     """Add faultnames from FAULTS keyword to connections"""
     eclfiles = EclFiles(DATAFILE)
-    nncdf = nnc.nnc2df(eclfiles)
+    nncdf = nnc.df(eclfiles)
     faultsdf = faults.deck2df(eclfiles.get_ecldeck())
 
     merged = pd.merge(