Metadata-Version: 1.2
Name: framat
Version: 0.4.2
Summary: FramAT (Frame Analysis Tool) is a tool for 3D FEM beam analyses
Home-page: https://github.com/airinnova/framat
Author: Aaron Dettmann
Author-email: dettmann@kth.se
License: Apache License 2.0
Description: .. image:: https://img.shields.io/pypi/v/framat.svg?style=flat
           :target: https://pypi.org/project/framat/
           :alt: Latest PyPI version
        
        .. image:: https://readthedocs.org/projects/framat/badge/?version=latest
            :target: https://framat.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/badge/license-Apache%202-blue.svg
            :target: https://github.com/airinnova/framat/blob/master/LICENSE.txt
            :alt: License
        
        .. image:: https://travis-ci.org/airinnova/framat.svg?branch=master
            :target: https://travis-ci.org/airinnova/framat
            :alt: Build status
        
        .. image:: https://codecov.io/gh/airinnova/framat/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/airinnova/framat
            :alt: Coverage
        
        |
        
        .. image:: https://raw.githubusercontent.com/airinnova/framat/master/docs/source/_static/images/logo/logo.png
            :alt: FramAT
            :width: 100 px
            :scale: 100 %
        
        *FramAT* (Frame Analysis Tool) is a tool for FEM beam analyses. Currently FramAT provides a full implementation of 3D Euler-Bernoulli beam theory which is also known as standard engineering beam theory.
        
        .. image:: https://raw.githubusercontent.com/airinnova/framat/master/docs/source/_static/images/main.png
            :target: https://github.com/airinnova/framat
            :alt: Example
            :scale: 50 %
        
        Installation
        ------------
        
        .. code::
        
            pip install framat
        
        To update an existing installation, run:
        
        .. code::
        
            pip install --upgrade framat
        
        
        Example
        -------
        
        FramAT provides a user-friendly, easy-to-read Python interface which can be integrated in complex workflows. Try it yourself. Just import the ``Model`` object from the FramAT library, and define your model.
        
        .. code:: python
        
            from framat import Model
        
            model = Model()
        
            mat = model.add_feature('material', uid='dummy')
            mat.set('E', 1)
            mat.set('G', 1)
            mat.set('rho', 1)
        
            cs = model.add_feature('cross_section', uid='dummy')
            cs.set('A', 1)
            cs.set('Iy', 1)
            cs.set('Iz', 1)
            cs.set('J', 1)
        
            beam = model.add_feature('beam')
            beam.add('node', [0, 0, 0], uid='root')
            beam.add('node', [1, 0, 0], uid='corner')
            beam.add('node', [1, 1, 0], uid='tip')
            beam.set('nelem', 10)
            beam.add('material', {'from': 'root', 'to': 'tip', 'uid': 'dummy'})
            beam.add('cross_section', {'from': 'root', 'to': 'tip', 'uid': 'dummy'})
            beam.add('orientation', {'from': 'root', 'to': 'tip', 'up': [0, 0, 1]})
            beam.add('point_load', {'at': 'corner', 'load': [0, 0, -1, 0, 0, 0]})
        
            bc = model.set_feature('bc')
            bc.add('fix', {'node': 'root', 'fix': ['all']})
        
            pp = model.set_feature('post_proc')
            pp.add('plot', ['undeformed', 'deformed', 'nodes'])
        
            model.run()
        
        Please refer to the documentation for installation instructions and a user guide:
        
        * https://framat.readthedocs.io/
        
        Additional information for developers
        -------------------------------------
        
        *For developers*: Recommended packages may be installed with the `requirements.txt`.
        
        .. code::
        
            pip install -r requirements.txt
        
        License
        -------
        
        **License:** Apache-2.0
        
        ⚠ Note
        ------
        
        From version 0.3.2 to 0.4.0 interface for *FramAT* has been changed completely to a more user-friendly Python API. Please refer to the documentation for instructions and examples. Older development versions can still be found under `releases <https://github.com/airinnova/framat/releases>`_ (not recommended). The current interface is still under development.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.6.0
