GithubHelp home page GithubHelp logo

drel's Introduction

dREL

This repository is for developing comprehensive documentation for the dREL dictionary methods language. dREL methods appear in dictionary data name definitions and are used to (re)calculate values that are missing from data files based on other values in those data files.

The current canonical reference for dREL is Spadaccini, N., Castleden, I. R., du Boulay, D. and Hall, S. R., "dREL: A relational expression language for dictionary methods", J. Chem. Inf. Model., 2012, 52 (8) pp 1917-1925. https://dx.doi.org/10.1021/ci300076w, in particular the appendix.

A further source of information that extends the language compared to the paper are the methods contained in the DDLm version of the core cif dictionary.

Documentation

Documentation currently consists solely of annotated_grammar.rst, together with the paper mentioned above.

Examples

All lines starting with 4 spaces or more in file annotated_grammar.rst can be extracted to create an EBNF that is close to the ISO standard, with differences noted in the annotated grammar. The Makefile in the Examples/Lark directory uses the annotated grammar and the Lark parser to create a fully-functional system for translating dREL code to Python and recursively executing it when provided with a CIF data file.

Three implementations exist of dREL. One is included in the JsCifBrowser javascript software of Doug du Boulay (see https://github.com/COMCIFS/JsCifBrowser) and another is bundled with the PyCIFRW software of James Hester (see https://bitbucket.org/jamesrhester/pycifrw). Neither can be considered to fully implement the specification in the paper, but both handle most or all dREL methods in approved IUCr CIF dictionaries.

A more up to date Julia implementation of dREL is available here.

Further examples using different coding languages and CIF access libraries are welcome, as are contributions to the above projects.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.