FEM-Design 0.0.5__tar.gz → 0.0.7__tar.gz

{fem_design-0.0.5/src/FEM_Design.egg-info → fem_design-0.0.7}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: FEM-Design
-Version: 0.0.5
+Version: 0.0.7
 Summary: The FEM-Design API package
 Author-email: FEM-Design <femdesign.api@strusoft.com>
 Maintainer-email: Marco Pellegrino <marco.pellegrino@strusoft.com>, Illyés Zoltán <sinnach@strusoft.hu>
 Project-URL: Homepage, https://femdesign-api-docs.onstrusoft.com
-Project-URL: Repository, https://github.com/strusoft/femdesign-api
+Project-URL: Repository, https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Python
 Project-URL: Issues, https://github.com/strusoft/femdesign-api/issues
 Keywords: fem,fea,structures,strusoft,FEM-Design API
 Classifier: Programming Language :: Python :: 3
@@ -48,17 +48,20 @@ pipe = FemDesignConnection()
 try:
     pipe.SetVerbosity(Verbosity.SCRIPT_LOG_LINES)
     pipe.Open(r"simple_beam.str")
+
+    static_analysis = Analysis.StaticAnalysis()
+    pipe.RunAnalysis(static_analysis)
+
     pipe.RunAnalysis(Analysis.FrequencyAnalysis(num_shapes=5))
-    pipe.Save(r"simple_beam_out.str")
-    pipe.GenerateListTables(bsc_file=r"quantity-estimation-steel.bsc",
-                            csv_file=r"quantity-estimation-steel.csv")
+    pipe.Save(r"simple_beam_out_2.str")
+
     pipe.Exit()
 except Exception as err:
     pipe.KillProgramIfExists()
     raise err
 ```
 
-A wider list of examples can be found in [example](https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Examples/Python).
+A wider list of examples can be found in [example](https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Examples/Python)
 
 ## Documentation
 

{fem_design-0.0.5 → fem_design-0.0.7}/README.md

@@ -31,17 +31,20 @@ pipe = FemDesignConnection()
 try:
     pipe.SetVerbosity(Verbosity.SCRIPT_LOG_LINES)
     pipe.Open(r"simple_beam.str")
+
+    static_analysis = Analysis.StaticAnalysis()
+    pipe.RunAnalysis(static_analysis)
+
     pipe.RunAnalysis(Analysis.FrequencyAnalysis(num_shapes=5))
-    pipe.Save(r"simple_beam_out.str")
-    pipe.GenerateListTables(bsc_file=r"quantity-estimation-steel.bsc",
-                            csv_file=r"quantity-estimation-steel.csv")
+    pipe.Save(r"simple_beam_out_2.str")
+
     pipe.Exit()
 except Exception as err:
     pipe.KillProgramIfExists()
     raise err
 ```
 
-A wider list of examples can be found in [example](https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Examples/Python).
+A wider list of examples can be found in [example](https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Examples/Python)
 
 ## Documentation
 

{fem_design-0.0.5 → fem_design-0.0.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "FEM-Design"
-version = "0.0.5"
+version = "0.0.7"
 authors = [
   { name="FEM-Design", email="femdesign.api@strusoft.com" },
 ]
@@ -20,5 +20,5 @@ keywords = ["fem", "fea", "structures", "strusoft", "FEM-Design API"]
 
 [project.urls]
 Homepage = "https://femdesign-api-docs.onstrusoft.com"
-Repository = "https://github.com/strusoft/femdesign-api"
+Repository = "https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Python"
 Issues = "https://github.com/strusoft/femdesign-api/issues"

{fem_design-0.0.5 → fem_design-0.0.7/src/FEM_Design.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: FEM-Design
-Version: 0.0.5
+Version: 0.0.7
 Summary: The FEM-Design API package
 Author-email: FEM-Design <femdesign.api@strusoft.com>
 Maintainer-email: Marco Pellegrino <marco.pellegrino@strusoft.com>, Illyés Zoltán <sinnach@strusoft.hu>
 Project-URL: Homepage, https://femdesign-api-docs.onstrusoft.com
-Project-URL: Repository, https://github.com/strusoft/femdesign-api
+Project-URL: Repository, https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Python
 Project-URL: Issues, https://github.com/strusoft/femdesign-api/issues
 Keywords: fem,fea,structures,strusoft,FEM-Design API
 Classifier: Programming Language :: Python :: 3
@@ -48,17 +48,20 @@ pipe = FemDesignConnection()
 try:
     pipe.SetVerbosity(Verbosity.SCRIPT_LOG_LINES)
     pipe.Open(r"simple_beam.str")
+
+    static_analysis = Analysis.StaticAnalysis()
+    pipe.RunAnalysis(static_analysis)
+
     pipe.RunAnalysis(Analysis.FrequencyAnalysis(num_shapes=5))
-    pipe.Save(r"simple_beam_out.str")
-    pipe.GenerateListTables(bsc_file=r"quantity-estimation-steel.bsc",
-                            csv_file=r"quantity-estimation-steel.csv")
+    pipe.Save(r"simple_beam_out_2.str")
+
     pipe.Exit()
 except Exception as err:
     pipe.KillProgramIfExists()
     raise err
 ```
 
-A wider list of examples can be found in [example](https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Examples/Python).
+A wider list of examples can be found in [example](https://github.com/strusoft/femdesign-api/tree/master/FemDesign.Examples/Python)
 
 ## Documentation
 

fem_design-0.0.7/src/femdesign/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.7"

{fem_design-0.0.5 → fem_design-0.0.7}/src/femdesign/calculate/analysis.py

@@ -304,7 +304,7 @@ class Analysis:
                  elemfine : bool = True,
                  diaphragm : bool = False,
                  peaksmoothings : bool = False,
-                 comb : CombSettings = None,
+                 combSettings : CombSettings = None,
                  stage : Stage = None,
                  freq : Freq = None,
                  footfall : Footfall = None,
@@ -334,7 +334,7 @@ class Analysis:
         self.peaksmoothings = peaksmoothings
         
         self.stage = stage
-        self.comb = comb
+        self.comb = combSettings
         self.freq = freq
         self.footfall = footfall
         #self.bedding = bedding
@@ -388,8 +388,12 @@ class Analysis:
         return analysis
 
     @classmethod
-    def StaticAnalysis(cls, comb : CombSettings = CombSettings.Default(), calcCase : bool = True, calcComb : bool = True):
-        return cls(calcCase = calcCase, calcComb = calcComb, comb = comb)
+    def StaticAnalysis(cls, calcCase : bool = True, calcComb : bool = True):
+        return cls(calcCase = calcCase, calcComb = calcComb)
+    
+    def SetCombinations(self, combSettings : CombSettings, combitems : list[CombItem]):
+        self.comb = combSettings
+        self.comb.combitems = combitems
     
     @classmethod
     def FrequencyAnalysis(cls, num_shapes : int = 5, auto_iter : int = 0, max_sturm : int = 0, norm_unit : Freq.ShapeNormalization  = Freq.ShapeNormalization.MassMatrix, x : bool = True, y : bool = True, z : bool = True, top : bool = -0.01):
@@ -397,8 +401,20 @@ class Analysis:
         return cls(calcFreq = True, freq = freq)
     
     @classmethod
-    def FootfallAnalysis(cls, footfall : Footfall, calcFootfall : bool = True):
-        return cls(calcFootfall = calcFootfall, footfall = footfall)
+    def FootfallAnalysis(cls, footfall : Footfall):
+        return cls(calcFootfall = True, footfall = footfall)
+
+    @classmethod
+    def GroundAcceleration(cls, thgroundacc : ThGroundAcc):
+        return cls(calcThGrounAcc = True, thgroundacc = thgroundacc)
+    
+    @classmethod
+    def ExcitationForce(cls, thexforce : ThExForce):
+        return cls(calcThExforce = True, thexforce = thexforce)
+    
+    @classmethod
+    def PeriodicExcitation(cls, periodicexc : PeriodicExc):
+        return cls(calcPeriodicExc = True, periodicexc = periodicexc)
 
 # class Bedding:
 #     def __init__(self, Ldcomb="a", Meshprep=0, Stiff_X=0.5, Stiff_Y=0.5):

{fem_design-0.0.5 → fem_design-0.0.7}/src/femdesign/calculate/command.py

@@ -383,6 +383,30 @@ class CmdSaveDocx(Command):
         return cmd_save_docx
 
 
+class CmdChild(Command):
+    """class to represent the fdscript cmdsavedocx command
+    """
+    def __init__(self, file_name : str):
+        """Constructor for the CmdChild class
+
+        Args:
+            file_name (str): path to the file to save
+        """
+        if not file_name.endswith(".dsc"):
+            raise ValueError("file_name must have suffix .dsc")
+
+        self.file_name = os.path.abspath(file_name)
+
+    def to_xml_element(self) -> ET.Element:
+        """Convert the CmdChild object to an xml element
+
+        Returns:
+            ET.Element: xml element representing the CmdChild object
+        """
+        cmd_child = ET.Element("cmdchild")
+        cmd_child.text = self.file_name
+
+        return cmd_child
 
 
 class CmdListGen:
@@ -406,7 +430,7 @@ class CmdListGen:
             raise ValueError("outfile must have suffix .csv")
 
         if not outfile:
-            outfile = pathlib.Path(self.bscfile).with_suffix(".csv")
+            outfile = pathlib.Path(bscfile).with_suffix(".csv")
 
         if not os.path.exists(os.path.dirname(os.path.abspath(outfile))):
             os.makedirs(os.path.dirname(os.path.abspath(outfile)))
@@ -442,4 +466,71 @@ class CmdListGen:
                 guid_elem = ET.SubElement(cmd_listgen, "GUID")
                 guid_elem.text = str(guid)
 
-        return cmd_listgen
+        return cmd_listgen
+
+class CmdConfig(Command):
+    """class to represent the fdscript cmdconfig command
+    """
+    def __init__(self, file_name : str):
+        """Constructor for the CmdConfig class
+
+        Args:
+            file_name (str): path to the config file
+        """
+        if not file_name.endswith(".xml"):
+            raise ValueError("file_name must have suffix .xml")
+
+        self.file_name = os.path.abspath(file_name)
+
+    def to_xml_element(self) -> ET.Element:
+        """Convert the CmdConfig object to an xml element
+
+        Returns:
+            ET.Element: xml element representing the CmdConfig object
+        """
+        cmd_config = ET.Element("cmdconfig")
+
+        attributes = {
+            "command": "$ MODULECOM APPLYCFG",
+            "file": self.file_name
+        }
+        cmd_config.attrib = attributes
+
+        return cmd_config
+    
+# <cmdinteractionsurface command="$ CODE_COM INTERACTIONSURFACE" guid="2e290437-e86a-4e36-af7d-acde6a6146c8" offset="0.0" fUlt="false" outfile="e:\res\a.txt"  />
+class CmdInteractionSurface(Command):
+    """class to represent the fdscript cmdinteraction surface command
+    """
+    def __init__(self, guid : uuid.UUID, outfile : str, offset : float = 0.0, fUlt : bool = False):
+        """Constructor for the CmdInteractionSurface class
+
+        Args:
+            guid (uuid.UUID): guid of an existing bar. make sure you pass the analytical bar!
+            outfile (str): path to the output file
+            offset (float): offset is cross-section position, measured along the bar from the starting point [m]
+            fUlt (bool): fUlt is true for Ultimate, false for Accidental or Seismic combination (different gammaC)
+        """
+        self.guid = guid
+        self.offset = offset
+        self.fUlt = fUlt
+        self.outfile = os.path.abspath(outfile)
+
+    def to_xml_element(self) -> ET.Element:
+        """Convert the CmdInteractionSurface object to an xml element
+
+        Returns:
+            ET.Element: xml element representing the CmdInteractionSurface object
+        """
+        cmd_interaction_surface = ET.Element("cmdinteractionsurface")
+
+        attributes = {
+            "command": "$ CODE_COM INTERACTIONSURFACE",
+            "guid": str(self.guid),
+            "offset": str(self.offset),
+            "fUlt": str(self.fUlt).lower(),
+            "outfile": self.outfile
+        }
+        cmd_interaction_surface.attrib = attributes
+
+        return cmd_interaction_surface

{fem_design-0.0.5 → fem_design-0.0.7}/src/femdesign/calculate/fdscript.py

@@ -12,6 +12,9 @@ class FdscriptHeader:
         self.version = str(version)
         self.module = module
         self.logfile = os.path.abspath(log_file)
+    
+        self.continue_on_error = True
+        self.ignore_Parse_error = True
 
 
     def to_xml_element(self) -> ET.Element:
@@ -21,7 +24,7 @@ class FdscriptHeader:
             ET.Element: xml element representing the FdscriptHeader object
         """
         fdscript_header = ET.Element("fdscriptheader")
-        
+
         title_elem = ET.SubElement(fdscript_header, "title")
         title_elem.text = self.title
 
@@ -34,6 +37,13 @@ class FdscriptHeader:
         logfile_elem = ET.SubElement(fdscript_header, "logfile")
         logfile_elem.text = self.logfile
 
+        ## add attributes
+        attributes = {
+            "fContinueOnError" : int(self.continue_on_error).__str__(),
+            "fIgnoreParseError" : int(self.ignore_Parse_error).__str__()
+        }
+
+        fdscript_header.attrib = attributes
 
         return fdscript_header
 
@@ -74,7 +84,7 @@ class Fdscript:
             fdscript.append(command.to_xml_element())
 
         return fdscript
-    
+
     def serialise_to_file(self, file_name : str):
         """Serialise the Fdscript object to a file
 

{fem_design-0.0.5 → fem_design-0.0.7}/src/femdesign/comunication.py

@@ -6,12 +6,15 @@ from enum import Enum
 from femdesign.calculate.analysis import Analysis, Design
 from femdesign.calculate.fdscript import Fdscript
 from femdesign.utilities.filehelper import OutputFileHelper
-from femdesign.calculate.command import DesignModule, CmdUser, CmdCalculation, CmdListGen, CmdOpen, CmdProjDescr, CmdSave
+from femdesign.calculate.command import *
 
 import win32file
 import win32pipe
 
 import os
+import shutil
+
+import uuid
 
 """
 FEM - Design usage with pipe
@@ -98,7 +101,7 @@ def GetElapsedTime(start_time):
 
 class _FdConnect:
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(self):
         self.Detach()
         self.ClosePipe()
 
@@ -293,18 +296,17 @@ class Verbosity(Enum):
     PROGRESS_WINDOW_TITLE = 32
 
 
-## define a private class
-
-
 class FemDesignConnection(_FdConnect):
     def __init__(self,
                  fd_path : str = r"C:\Program Files\StruSoft\FEM-Design 23\fd3dstruct.exe",
                  pipe_name : str ="FdPipe1",
                  verbose : Verbosity = Verbosity.SCRIPT_LOG_LINES,
                  output_dir : str = None,
-                 minimized : bool = False,):
+                 minimized : bool = False,
+                 delete_dir : bool = True):
         super().__init__(pipe_name)
 
+        self.delete_dir = delete_dir
         self._output_dir = output_dir
 
         os.environ["FD_NOLOGO"] = "1"
@@ -315,6 +317,14 @@ class FemDesignConnection(_FdConnect):
         self.Start(fd_path)
         self.LogLevel(verbose)
 
+    def __exit__(self):
+        super().__exit__()
+        if(self.delete_dir):
+            try:
+                shutil.rmtree(os.path.join(self.output_dir, "scripts"))
+            except:
+                pass
+
     @property
     def output_dir(self):
         if self._output_dir == None:
@@ -327,7 +337,6 @@ class FemDesignConnection(_FdConnect):
         self._output_dir = os.path.abspath(value)
         if not os.path.exists(value):
             os.makedirs(os.path.abspath(value))
-
     
     def RunScript(self, fdscript : Fdscript, file_name : str = "script"):
         """
@@ -429,7 +438,7 @@ class FemDesignConnection(_FdConnect):
         log = OutputFileHelper.GetLogFilePath(self.output_dir)
 
         if not file_name.endswith(".struxml") and not file_name.endswith(".str"):
-            raise ValueError(f"File {file_name} must have extension .struxml or .str")
+            raise ValueError(f"file_name must have extension .struxml or .str")
         if not os.path.exists(file_name):
             raise FileNotFoundError(f"File {file_name} not found")
 
@@ -447,8 +456,86 @@ class FemDesignConnection(_FdConnect):
         fdscript = Fdscript(log, [cmd_results])
         self.RunScript(fdscript, "generate_list_tables")
         
+    def SaveDocx(self, file_name : str, template_file : str = None):
+        """Save the project as docx
+
+        Args:
+            file_name (str): name of the file to save
+
+        Examples
+        --------
+        >>> pipe = FemDesignConnection()
+        >>> pipe.SaveDocx(r"outputFile.docx")
+        """
+        log = OutputFileHelper.GetLogFilePath(self.output_dir)
+
+
+        if template_file:
+            self.ApplyDocumentationTemplate(template_file)
+
+        cmd_save_docx = CmdSaveDocx(file_name)
+
+
+        fdscript = Fdscript(log, [cmd_save_docx])
+        self.RunScript(fdscript, "save_docx")
+    
+    def ApplyDocumentationTemplate(self, template_file : str):
+        """Apply documentation template
+
+        Args:
+            template_file (str): template file path
+        """
+        log = OutputFileHelper.GetLogFilePath(self.output_dir)
+
+        cmd_child = CmdChild(template_file)
+        fdscript = Fdscript(log, [cmd_child])
+        self.RunScript(fdscript, "apply_documentation_template")
+
+    def GenerateInteractionSurface(self, guid : uuid.UUID, outfile : str, offset : float = 0.0, fUlt : bool = True):
+        """Generate interaction surface
+
+        Args:
+            guid (uuid.UUID): guid of an existing bar. make sure you pass the analytical bar!
+            outfile (str): path to the output file
+            offset (float): offset is cross-section position, measured along the bar from the starting point [m]
+            fUlt (bool): fUlt is true for Ultimate, false for Accidental or Seismic combination (different gammaC)
+        """
+        log = OutputFileHelper.GetLogFilePath(self.output_dir)
+
+        cmd_interaction_surface = CmdInteractionSurface(guid, outfile, offset, fUlt)
+        fdscript = Fdscript(log, [cmd_interaction_surface])
+        self.RunScript(fdscript, "generate_interaction_surface")
+    
+    def SetDesignParameters(self, file_path : str):
+        """Set design parameters
+
+        Args:
+            file_path (str): path to the file
+        """
+        log = OutputFileHelper.GetLogFilePath(self.output_dir)
+
+        cmd_design_parameters = CmdConfig(file_path)
+        fdscript = Fdscript(log, [cmd_design_parameters])
+        self.RunScript(fdscript, "set_design_parameters")
 
     ## it does not work
-    def Disconnect(self):
+    # def DumpDesignParameters(self, file_path : str):
+    #     """Dump calculation and design parameters
+
+    #     Args:
+    #         file_path (str): xml file path where the design and calculation parameters will be dumped
+    #     """
+    #     if not file_path.endswith(".xml"):
+    #         raise ValueError("file_name must have suffix .xml")
+
+    #     file_path = os.path.abspath(file_path)
+    #     message = f"; CXL MODULECOM WXMLCFG:{file_path}"
+    #     self.Send(message)
+
+    # ## it does not work
+    # def Disconnect(self):
         super().Detach()
         win32pipe.DisconnectNamedPipe(self.pipe_send)
+
+    def Close(self):
+        self.__exit__()