Merge pull request #1 from Loop3D/pythonic

Pythonic

Author: RoyThomsonMonash

.github/workflows/publish_conda.yml

@@ -1,7 +1,8 @@
 name: publish_conda
 
 on:
-   push
+   release:
+      types: [published]
 jobs:
   conda-deploy:
     name: Uploading to Loop3d for python ${{ matrix.os }})

.gitignore

@@ -1,3 +1,4 @@
 __pycache__
 *.swp
 *.swo
+LoopProjectFile.egg-info/*

LoopProjectFile/LoopProjectFile.py

@@ -449,8 +449,23 @@ def ConvertDataFrame(df,dtype):
     else:
         raise NotADataFrame
 
+def CheckFileIsLoopProjectFile(filename, verbose=False):
+    """
+    Check that the file is a valid Loop Project File
+    """
+    fileResp = OpenProjectFile(filename, readOnly=True, verbose=verbose)
+    if fileResp["errorFlag"]: 
+        valid = False
+        print('Project file is not a LoopProjectFile')
+    else:
+        rootgrp = fileResp["root"]
+        rootgrp.close()
+        valid = True
+    return valid
+
+    
 def ConvertToDataFrame(data,loopCompoundType):
     columns = list(loopCompoundType.names)
     df = pandas.DataFrame.from_records(data, columns=columns)
     df = df.applymap(lambda x:x.decode() if isinstance(x,bytes) else x)
-    return df
+    return df

LoopProjectFile/LoopProjectFileUtils.py

@@ -26,7 +26,7 @@ def GetGroup(node,groupName,verbose=False):
         if verbose: print(errStr)
         return {"errorFlag":True,"errorString":errStr}
 
-def ElementFromCsv(loopFilename,importFilename,element,loopCompoundType):
+def ElementFromDataframe(loopFilename,df,element,loopCompoundType):
     """
     **ElementFromCsv** - Imports one element of the loop project file
     from a csv file into the project file
@@ -46,22 +46,51 @@ def ElementFromCsv(loopFilename,importFilename,element,loopCompoundType):
     -------
 
     """
-    if not os.path.isfile(importFilename):
-        print(importFilename,'does not exist')
+    if isinstance(df,pandas.DataFrame) == False:
+        print('not a dataframedoes not exist')
         return
     if not os.path.isfile(loopFilename):
         print(loopFilename,'does not exist. Try LoopProjectFile.CreateBasic first')
         return
-    df = pandas.read_csv(importFilename)
     if len(df.columns) != len(loopCompoundType):
-        print('In ',importFilename,'columns do not match compound type')
+        print('In dataframe columns do not match compound type')
         print('  Dataframe:',df.columns,' does not match\n  Compound type:',loopCompoundType.names)
         return
     struct = LoopProjectFile.ConvertDataFrame(df,loopCompoundType)
     resp = LoopProjectFile.Set(loopFilename,element,data=struct)
     if resp['errorFlag']:
         print(resp['errorString'])
 
+def ElementFromCsv(loopFilename,importFilename,element,loopCompoundType):
+    """
+    **ElementFromCsv** - Imports one element of the loop project file
+    from a csv file into the project file
+
+    Parameters
+    ----------
+    loopFilename: string
+        The filename of the loop project file
+    importFilename: string
+        The filename of the csv file containing the element data
+    element: string
+        The name of the element to extract
+    loopCompoundType: numpy.compoundType
+        The numpy data structure that the element is stored in
+
+    Returns
+    -------
+
+    """
+    if not os.path.isfile(importFilename):
+        print(importFilename,'does not exist')
+        return
+    if not os.path.isfile(loopFilename):
+        print(loopFilename,'does not exist. Try LoopProjectFile.CreateBasic first')
+        return
+    df = pandas.read_csv(importFilename)
+    ElementFromDataframe(loopFilename,df,element,loopCompoundType)
+    
+
 def FromCsv(loopFilename,importPath,overwrite=False):
     """
     **FromCsv** - Imports all elements of the loop project file
@@ -146,7 +175,7 @@ def FromCsv(loopFilename,importPath,overwrite=False):
     print('  Importing from',str(importPath)+'eventRel.csv','into project file')
     ElementFromCsv(loopFilename,importPath+'eventRel.csv','eventRelationships',LoopProjectFile.eventRelationshipType)
 
-def ElementToCsv(loopFilename,outputFilename,element,loopCompoundType):
+def ElementToDataframe(loopFilename,element,loopCompoundType):
     """
     **ElementToCsv** - Exports one element of the loop project file
     to a csv file outputFilename
@@ -155,8 +184,6 @@ def ElementToCsv(loopFilename,outputFilename,element,loopCompoundType):
     ----------
     loopFilename: string
         The filename of the loop project file
-    outputFilename: string
-        The filename of the csv file which will contain the element data
     element: string
         The name of the element to extract
     loopCompoundType: numpy.compoundType
@@ -169,12 +196,40 @@ def ElementToCsv(loopFilename,outputFilename,element,loopCompoundType):
     resp = LoopProjectFile.Get(loopFilename,element)
     if resp['errorFlag']:
         print(resp['errorString'])
+        return None
     else:
         columns = list(loopCompoundType.names)
         df = pandas.DataFrame.from_records(resp['value'],columns=columns)
+        for name in columns:
+            df[name] = df[name].astype(loopCompoundType[name])
         df = df.applymap(lambda x:x.decode() if isinstance(x,bytes) else x)
-        df.set_index(columns[0],inplace=True)
+        # df.set_index(columns[0],inplace=True)
+        return df#.to_csv(outputFilename)
+
+def ElementToCsv(loopFilename,outputFilename,element,loopCompoundType):
+    """
+    **ElementToCsv** - Exports one element of the loop project file
+    to a csv file outputFilename
+
+    Parameters
+    ----------
+    loopFilename: string
+        The filename of the loop project file
+    outputFilename: string
+        The filename of the csv file which will contain the element data
+    element: string
+        The name of the element to extract
+    loopCompoundType: numpy.compoundType
+        The numpy data structure that the element is stored in
+
+    Returns
+    -------
+
+    """
+    df = ElementToDataframe(loopFilename,element,loopCompoundType)
+    if df:
         df.to_csv(outputFilename)
+    
 
 def ToCsv(loopFilename,outputPath):
     """

LoopProjectFile/__init__.py

@@ -3,7 +3,8 @@
         faultObservationType, foldObservationType, foliationObservationType, discontinuityObservationType, \
         stratigraphicLayerType, stratigraphicObservationType, contactObservationType, \
         eventRelationshipType, drillholeObservationType, drillholeDescriptionType, \
-        ConvertDataFrame, ConvertToDataFrame, EventType, EventRelationshipType
+        ConvertDataFrame, ConvertToDataFrame, EventType, EventRelationshipType, CheckFileIsLoopProjectFile
 from .Permutations import Event, perm, ApproxPerm, CalcPermutation, checkBrokenRules, checkBrokenEventRules
-from .LoopProjectFileUtils import ToCsv, FromCsv, ElementToCsv, ElementFromCsv
+from .LoopProjectFileUtils import ToCsv, FromCsv, ElementToCsv, ElementFromCsv, ElementToDataframe, ElementFromDataframe
 from .Version import LoopVersion
+from .projectfile import ProjectFile