Skip to main content

GUI for CLEASE

Project description

pipeline status coverage report Documentation Status PyPI Anaconda

Code style: black

CLEASE GUI

This is a GUI based on Jupyter notebooks for CLEASE. For more information, head on over to the documentation.

Installation

The CLEASE GUI is available on PyPI:

$ pip install clease-gui

The GUI is also available on conda-forge. This is also the prefered method on Windows, in order to simply the compilation process of CLEASE. To install into your conda environment, do:

$ conda install -c conda-forge clease-gui

Running the GUI

The GUI is based on Jupyter notebooks. The GUI works in both "classic" jupyter notebooks, and in Jupyter lab. Launch jupyter lab with:

$ jupyter-lab

Alternatively to use the classic jupyter notebook, do:

$ jupyter notebook

Create a new notebook that you want to work in, and a new cell, add the following lines:

%matplotlib tk
from clease_gui import display_ui
display_ui(dev_mode=True);

A line %matplotlib notebook can be added at the start of the cell for nicer plots (this only works in classic jupyter notebooks). 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:

import matplotlib
matplotlib.rcParams.update({'font.size': 16})

This will also affect the font sizes on the figures generated in the GUI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clease-gui-0.2.2.tar.gz (77.4 kB view details)

Uploaded Source

Built Distribution

clease_gui-0.2.2-py3-none-any.whl (94.4 kB view details)

Uploaded Python 3

File details

Details for the file clease-gui-0.2.2.tar.gz.

File metadata

  • Download URL: clease-gui-0.2.2.tar.gz
  • Upload date:
  • Size: 77.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for clease-gui-0.2.2.tar.gz
Algorithm Hash digest
SHA256 b053ba1f55814857674e94672dc4fdc47d2e6887b49a0c3a3d9fa8f1ddcb16c9
MD5 383af112d9b0db585368ff40b071d88f
BLAKE2b-256 4777d51f4517045145dc1f8e68a51cb7a36c7b4f4fbf4711c61668a033421a1e

See more details on using hashes here.

File details

Details for the file clease_gui-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: clease_gui-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 94.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for clease_gui-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1b22f56a664d830f339552618a3735ef5978e75ba5abe48f498682908c05b02e
MD5 d9960f8f7ca8f43a1e246faf87b13b70
BLAKE2b-256 122b0cf441a0de4f31cd26ba76c07ad181c6e1aa2309d796a2b2f0f912d2b0a7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page