Metadata-Version: 1.0
Name: dichalcogenides
Version: 0.2.1
Summary: Python analysis code for dichalcogenide systems.
Home-page: https://github.com/razor-x/dichalcogenides
Author: Evan Sosenko
Author-email: razorx@evansosenko.com
License: MIT
Description: Dichalcogenides
        =======================
        
        |PyPI| |GitHub-license| |Requires.io| |CircleCI| |Documentation|
        
            Built from `makenew/python-package <https://github.com/makenew/python-package>`__.
        
        .. |PyPI| image:: https://img.shields.io/pypi/v/dichalcogenides.svg
           :target: https://pypi.python.org/pypi/dichalcogenides
           :alt: PyPI
        .. |GitHub-license| image:: https://img.shields.io/github/license/razor-x/dichalcogenides.svg
           :target: ./LICENSE.txt
           :alt: GitHub license
        .. |Requires.io| image:: https://img.shields.io/requires/github/razor-x/dichalcogenides.svg
           :target: https://requires.io/github/razor-x/dichalcogenides/requirements/
           :alt: Requires.io
        .. |CircleCI| image:: https://img.shields.io/circleci/project/razor-x/dichalcogenides.svg
           :target: https://circleci.com/gh/razor-x/dichalcogenides
           :alt: CircleCI
        .. |Documentation| image:: https://readthedocs.org/projects/dichalcogenides/badge/?version=latest
           :target: http://dichalcogenides.readthedocs.org/en/latest/?badge=latest
           :alt: Documentation Status
        
        Description
        -----------
        
        Python analysis code for dichalcogenide systems.
        
        Considered unstable and in development until version 1.0.0 is released.
        
        Installation
        ------------
        
        This package is registered on the `Python Package Index (PyPI)`_
        as dichalcogenides_.
        
        Add this line to your application's requirements.txt
        
        ::
        
            dichalcogenides
        
        and install it with
        
        ::
        
            $ pip install -r requirements.txt
        
        If you are writing a Python package which will depend on this,
        add this to your requirements in ``setup.py``.
        
        Alternatively, install it directly using pip with
        
        ::
        
            $ pip install dichalcogenides
        
        .. _dichalcogenides: https://pypi.python.org/pypi/dichalcogenides
        .. _Python Package Index (PyPI): https://pypi.python.org/
        
        Development and Testing
        -----------------------
        
        Source Code
        ~~~~~~~~~~~
        
        The `dichalcogenides source`_ is hosted on GitHub.
        Clone the project with
        
        ::
        
            $ git clone https://github.com/razor-x/dichalcogenides.git
        
        .. _dichalcogenides source: https://github.com/razor-x/dichalcogenides
        
        Requirements
        ~~~~~~~~~~~~
        
        You will need `Python 3`_ with pip_.
        
        Install the development dependencies with
        
        ::
        
            $ pip install -r requirements.devel.txt
        
        .. _pip: https://pip.pypa.io/
        .. _Python 3: https://www.python.org/
        
        Tests
        ~~~~~
        
        Lint code with
        
        ::
        
            $ python setup.py lint
        
        
        Run tests with
        
        ::
        
            $ python setup.py test
        
        Contributing
        ------------
        
        Please submit and comment on bug reports and feature requests.
        
        To submit a patch:
        
        1. Fork it (https://github.com/razor-x/dichalcogenides/fork).
        2. Create your feature branch (``git checkout -b my-new-feature``).
        3. Make changes. Write and run tests.
        4. Commit your changes (``git commit -am 'Add some feature'``).
        5. Push to the branch (``git push origin my-new-feature``).
        6. Create a new Pull Request.
        
        License
        -------
        
        This Python package is licensed under the MIT license.
        
        Warranty
        --------
        
        This software is provided "as is" and without any express or implied
        warranties, including, without limitation, the implied warranties of
        merchantibility and fitness for a particular purpose.
        
Platform: UNKNOWN
