Skip to main content

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.

Metadata

Release files for clease-gui 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clease-gui 0.2.2
File Size Uploaded
clease-gui-0.2.2.tar.gz 77.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for clease-gui 0.2.2
File Interpreter ABI Platform
clease_gui-0.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 171.8 kB

Release files / clease-gui-0.2.2.tar.gz

Download URL clease-gui-0.2.2.tar.gz
Size 77.4 kB
Tags Source
SHA-256 checksum
How to use checksums
b053ba1f55814857674e94672dc4fdc47d2e6887b49a0c3a3d9fa8f1ddcb16c9
BLAKE2b-256 checksum
How to use checksums
4777d51f4517045145dc1f8e68a51cb7a36c7b4f4fbf4711c61668a033421a1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.7

Release files / clease_gui-0.2.2-py3-none-any.whl

Download URL clease_gui-0.2.2-py3-none-any.whl
Size 94.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1b22f56a664d830f339552618a3735ef5978e75ba5abe48f498682908c05b02e
BLAKE2b-256 checksum
How to use checksums
122b0cf441a0de4f31cd26ba76c07ad181c6e1aa2309d796a2b2f0f912d2b0a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.7
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page