Metadata-Version: 2.1
Name: clease-gui
Version: 0.0.1rc1
Summary: CLuster Expansion in Atomistic Simulation Environment GUI
Home-page: https://gitlab.com/computationalmaterials/clease-gui
Author: Alexander S. Tygesen
Author-email: alexty@dtu.dk
License: MPL-2.0
Project-URL: Documentation, https://clease-gui.readthedocs.io/
Project-URL: Source, https://gitlab.com/computationalmaterials/clease-gui
Description: [![pipeline status](https://gitlab.com/computationalmaterials/clease-gui/badges/master/pipeline.svg)](https://gitlab.com/computationalmaterials/clease-gui/-/commits/master) 
        [![coverage report](https://gitlab.com/computationalmaterials/clease-gui/badges/master/coverage.svg)](https://gitlab.com/computationalmaterials/clease-gui/-/commits/master)
        [![Documentation Status](https://readthedocs.org/projects/clease-gui/badge/?version=latest)](https://clease-gui.readthedocs.io/en/latest/?badge=latest)
        [![PyPI](https://img.shields.io/pypi/v/clease-gui)](https://pypi.org/project/clease-gui/)
        
        # CLEASE GUI
        This is a GUI based on Jupyter notebooks for [CLEASE](https://gitlab.com/computationalmaterials/clease).
        For more information, head on over to the [documentation](https://clease-gui.readthedocs.io).
        
        ## Installation
        
        The CLEASE GUI is available on [PyPI](https://pypi.org/project/clease-gui/):
        
            $ pip install clease-gui
        
        ## Running the GUI
        The GUI is based on Jupyter notebooks. To launch a new notebook, do:
        
            $ jupyter notebook
        
        Create a new notebook that you want to work in, and a new cell, add the following lines:
        
        ```python
        from clease_gui import display_ui
        display_ui()
        ```
        
        A line `%matplotlib notebook` can be added at the start of the cell for nicer plots. However, this may come at a significant performance cost, so do your own testing.
        
        ## Plot font sizes
        
        All plots generated in this package are generated by the ``matplotlib`` package. However, the default font size in ``matplotlib`` can be rather small,
        so it can be adjusted globally, e.g. by running the following in a cell:
        ```python
        import matplotlib
        matplotlib.rcParams.update({'font.size': 16})
        ```
        This will also affect the font sizes on the figures generated in the GUI.
        
Keywords: Cluster Expansion,Monte Carlo,Computational materials,Materials research,GUI,Graphical User Interface
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: doc
Provides-Extra: full
