.. _topics-index:

=====================
GlassPy documentation
=====================

GlassPy is a Python module for researchers working with `glass materials`_ and
`glass-forming liquids`_. Currently, GlassPy focuses on glass data and
predictive models. GlassPy provides a convenient way to load data from the
`SciGlass database`_ into a Pandas DataFrame. GlassPy is also the home to
GlassNet, VITRIFY, and ViscNet. GlassNet is a predictive model for many glass
properties.  VITRIFY is a predictive model of the probability of glass
formation. ViscNet is a predictive model for viscosity. GlassPy is still under
development; changes to the API are not only likely, but expected as development
continues.

.. _glass materials: https://en.wikipedia.org/wiki/Glass
.. _glass-forming liquids: https://en.wikipedia.org/wiki/Viscous_liquid
.. _Sciglass database: https://github.com/epam/SciGlass

First steps
===========

.. toctree::
   :caption: First steps
   :hidden:

   intro/install
   intro/examples

:doc:`intro/install`
    Install GlassPy on your computer.

:doc:`intro/examples`
    Check out some examples of what GlassPy can do.

API Documentation
=================

.. toctree::
   :maxdepth: 2

   modules/modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`