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

Uploaded Source

Built Distribution

clease_gui-0.1.1-py3-none-any.whl (70.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clease-gui-0.1.1.tar.gz
  • Upload date:
  • Size: 53.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for clease-gui-0.1.1.tar.gz
Algorithm Hash digest
SHA256 765b160920fcfbc023676dfc0a3841ff90b7e09cc5a74da47e70b5492da2d2a2
MD5 82f55e8e4dadd04ea7dcd7003f472ce5
BLAKE2b-256 92c8eb799fafbcfe445e6a79859d5e496dcaa69d731c33144bfa2a9fea5bc304

See more details on using hashes here.

File details

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

File metadata

  • Download URL: clease_gui-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 70.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for clease_gui-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 67c2e0bf7724ad1ef3efa01551e91aca5cd2f51583370e07d7ff7897e03cd9c8
MD5 b71baf996df63dedaf57137785dea5aa
BLAKE2b-256 d938f70d396688b73d90849e5fe6bab759de79c22dd31b0dbf7ee4b9df00bf06

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