Metadata-Version: 2.0
Name: ejplugins
Version: 0.4.2
Summary: parser plugins for jsonextended
Home-page: UNKNOWN
Author: Chris Sewell
Author-email: chrisj_sewell@hotmail.com
License: MIT
Description-Content-Type: UNKNOWN
Keywords: python,parser,quantum-espresso,crystal,lammps,gulp
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Dist: jsonextended (>=0.6.4)
Requires-Dist: jsonschema
Requires-Dist: pymatgen
Requires-Dist: ase

ejplugins
=========

|Build_Status| |PyPI|

Parser plugins for the `jsonextended
package <https://jsonextended.readthedocs.io>`__ and validation schema,
to convert output files from materials simulation packages to a JSON
format.

Usage
-----

::

    pip install ejplugins
    pip install jsonextended

Either use independently:

.. code:: python

    from ejplugins.qespresso import QEmainPlugin
    with open("path/to/my.qe.out") as f:
        output = QEmainPlugin.read_file(f)

Or with ``jsonextended``:

.. code:: python

    from ejplugins.qespresso import QEmainPlugin
    from jsonextended import plugins, ejson
    plugins.load_plugin_classes([QEmainPlugin])

    ejson.to_dict("path/to/qespresso/outputs")

See ejplugins/test\_files for example input/outputs.

.. |Build_Status| image:: https://travis-ci.org/chrisjsewell/ejplugins.svg?branch=master
   :target: https://travis-ci.org/chrisjsewell/ejplugins
.. |PyPI| image:: https://img.shields.io/pypi/v/ejplugins.svg
   :target: https://pypi.python.org/pypi/ejplugins/


