Metadata-Version: 2.1
Name: ele
Version: 0.2.0
Summary: A lightweight package with the periodic table of the elements
Home-page: https://github.com/rsdefever/ele
Author: Ryan S. DeFever
Author-email: rdefever@nd.edu
License: MIT
Description: 
        Ele
        ===
        |License|
        |CodeCov|
        |Azure|
        
        .. |Codecov| image:: https://codecov.io/gh/rsdefever/ele/branch/master/graph/badge.svg
        .. |Azure| image:: https://dev.azure.com/rdefever/ele/_apis/build/status/rsdefever.ele?branchName=master
        .. |License| image:: https://img.shields.io/github/license/rsdefever/ele
        
        Overview
        ~~~~~~~~
        
        **Ele**\ ment is an extremely lightweight package that defines
        the elements of the periodic table and allows them to be accessed
        by symbol, name, atomic number, or mass. It has *zero dependencies*
        outside of the Python Standard Library.
        
        Warning
        ~~~~~~~
        
        **Ele** is still in early development (0.x releases). The API may
        change unexpectedly.
        
        Usage
        ~~~~~
        
        **Ele** only supports a few modes of use. You can retrieve an element
        from the symbol, the name, the atomic number, or the mass (in amu):
        
        .. code-block:: python
        
          import ele
          na = ele.element_from_symbol("Na")
          na = ele.element_from_name("sodium")
          na = ele.element_from_atomic_number(11)
          na = ele.element_from_mass(22.990)
        
        The mass is rounded to a single decimal before comparison. If you wish to
        retrieve the element with the mass closest to the specified value you
        may use the ``exact=False`` keyword.
        
        Each ``Element`` has four attributes which can be accessed
        (as demonstrated below for ``na``):
        
        .. code-block:: python
        
          na.name
          na.symbol
          na.atomic_number
          na.mass
        
        The elements can also be accessed by symbol as follows:
        
        .. code-block:: python
        
          import ele
          na = ele.Elements.Na
        
        Installation
        ~~~~~~~~~~~~
        
        Install via `pip`:
        
        .. code-block:: bash
        
          pip install ele
        
        or `conda`:
        
        .. code-block:: bash
        
          conda install -c conda-forge ele
        
        Installation from source is also an option:
        
        .. code-block:: bash
        
          git clone git@github.com/rsdefever/ele.git
          cd ele
          pip install .
        
        
        Data Sources
        ~~~~~~~~~~~~
        
        Complete details of the sources are provided `here <https://github.com/rsdefever/ele/blob/master/ele/lib/README.md>`_
        
        
        Credits
        ~~~~~~~
        
        Development of Ele was supported by the National Science Foundation
        under grant NSF Grant Number 1835874. Any opinions, findings, and conclusions or
        recommendations expressed in this material are those of the author(s) and do
        not necessarily reflect the views of the National Science Foundation.
        
Platform: UNKNOWN
Requires-Python: >=3.6, <4
Description-Content-Type: text/x-rst
