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. 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:

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:

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.1.3.tar.gz (69.7 kB view details)

Uploaded Source

Built Distribution

clease_gui-0.1.3-py3-none-any.whl (86.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clease-gui-0.1.3.tar.gz
  • Upload date:
  • Size: 69.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for clease-gui-0.1.3.tar.gz
Algorithm Hash digest
SHA256 bfa8d4aa3707878858fa24fa90626abc04b07e276a31a99e8d54bb664e14d0d6
MD5 0317a47bd28954b511edf6b425aa09dc
BLAKE2b-256 845177d145d8b6e616d3b79d9082b8785d98de3e793dc317b16965f8fdfefc63

See more details on using hashes here.

File details

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

File metadata

  • Download URL: clease_gui-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 86.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for clease_gui-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fd4125b4ae4a9682c59760c60699d443498e24d328405c1af131fe46f0b48c61
MD5 45b7724ae4f4f6f6cc7dee271eb23174
BLAKE2b-256 28208c25952299d2642ad03ead700212fe07d9fc9d18859058c80713a618415d

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