Metadata-Version: 1.1
Name: ELLIPTIc
Version: 1.0.0
Summary: A tool for building DSLs for scientific purposes.
Home-page: https://github.com/padmec-reservoir/ELLIPTIc
Author: Guilherme Caminha
Author-email: gpkc@cin.ufpe.br
License: MIT license
Description-Content-Type: UNKNOWN
Description: <p align="center">
          <img src="https://cdn.rawgit.com/gpkc/ELLIPTIc/master/logo.png"/>
        </p>
        
        ---
        
        [![Build Status](https://travis-ci.org/padmec-reservoir/ELLIPTIc.svg?branch=master)](https://travis-ci.org/padmec-reservoir/ELLIPTIc)
        [![Documentation Status](https://readthedocs.org/projects/elliptic/badge/?version=latest)](http://elliptic.readthedocs.io/en/latest/?badge=latest)
        [![Coverage Status](https://coveralls.io/repos/github/padmec-reservoir/ELLIPTIc/badge.svg?branch=master)](https://coveralls.io/github/padmec-reservoir/ELLIPTIc?branch=master)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/025660097e6a41fa9fa6fa590ef28148)](https://www.codacy.com/app/gpkc/ELLIPTIc?utm_source=github.com&utm_medium=referral&utm_content=padmec-reservoir/ELLIPTIc&utm_campaign=badger)
        [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/gpkc/ELLIPTIc/master/LICENSE)
        
        <p align="center">
          <img src="https://cdn.rawgit.com/gpkc/ELLIPTIc/master/pic.png" width="500"/>
        </p>
        
        
        # Description
        **ELLIPTIc**, The ExtensibLe LIbrary for Physical simulaTIons, is a library / framework for creating reusable and extensible
        [Domain Specific Languages (DSL)](https://martinfowler.com/bliki/DomainSpecificLanguage.html) for scientific purposes.
        
        ELLIPTIc's workflow is as follows:
        
        * An ELLIPTIc DSL contract is created to define how the DSL syntax looks like. This DSL contract defines the operations
        that will be available when using the DSL.
        * A DSL implementation is built based on the DSL contract. The DSL implementation tells ELLIPTIc how to generate the
        corresponding Cython code.
        * When using ELLIPTIc-based DSLs, a tree-like intermediate representation is built.
        * This intermediate representation is used together with the DSL implementation to generate Cython code.
        
        # DSL Syntax
        
        ELLIPTIc-based DSLs use a [Fluent Interface](https://martinfowler.com/bliki/FluentInterface.html) syntax. This allows
        for elegant development of algorithms.
        
        Below is an example of how using an ELLIPTIc-based DSL to iterate in a unstructured mesh would look like:
        
        ```python
        dsl = DSL(...)  # Instatiating a DSL object
        
        
        with dsl.root() as root:
            all_ents = root.Entities(dim=3).Adjacencies(bridge_dim=2, to_dim=3)  # Operation chaining
            internal_ents = all_ents.Where(boundary=False)  # Continuing an operation chain
            boundary_ents = all_ents.Where(boundary=True)  # Operation branching
            
            perm_ents = internal_ents.GetField(name="permeability")
            dirichlet = boundary_ents.GetField(name="dirichlet")
            neumann = boundary_ents.GetField(name="neumann")
        
        dsl.get_built_module().run()  # Run the generated Cython code
        ```
        
        It is also possible to export the intermediate representation to a image file, allowing for visual debugging:
        
        <p align="center">
          <img src="https://cdn.rawgit.com/gpkc/ELLIPTIc/master/tree_example.png" width="500"/>
        </p>
        
        
        # Documentation
        Please refer to the [documentation page](http://elliptic.readthedocs.io/en/latest/).
        
        # Testing
        Run `python setup.py test`.
        
        # Building and installing
        Run `python setup.py build` and `python setup.py install`.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
