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

Uploaded Source

Built Distribution

clease_gui-0.1.4-py3-none-any.whl (85.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clease-gui-0.1.4.tar.gz
  • Upload date:
  • Size: 69.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.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.4.tar.gz
Algorithm Hash digest
SHA256 49b155e41b8683e7e8dbd6b613196445eafc4921a809023e3ed01a404d92a2cc
MD5 b068a8ec588645375a196537c74781be
BLAKE2b-256 ed94e445e988dfb9e6c45112282c193b3514907e6430688f9633c71946306063

See more details on using hashes here.

File details

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

File metadata

  • Download URL: clease_gui-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 85.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6eb4b0cd42f57aeb3e64035158e5fc6a8bdd4f2f81276e58aaa09e98c8bb6ef9
MD5 142eeff736255d1770387e75760f8607
BLAKE2b-256 5fd5cd9f0362e85e60fa7e75584586ac56c2a4715f8c49e775a3d07559d7d525

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