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

Uploaded Source

Built Distribution

clease_gui-0.1.2-py3-none-any.whl (70.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for clease-gui-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1860305600d26b4f0a80bfc18e09274c8d1bf2f6f02160453793a3fc278e1c62
MD5 6d503482cf6eb871dbff126636d910a5
BLAKE2b-256 76d4bc2af16f5e45eaf14ffd9f47d59a3627b94f6592cd52978dce4860fe94f9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for clease_gui-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9b6aad3a3abf9fc7d7a6f889ecd9b64ee93d3b8c9e77e1eb3fa2f6fa1e377b13
MD5 3e7b7d37170950caec3bbfebf9efe2a9
BLAKE2b-256 1c11021236699234f1d9626d2058096b288418e5cf4761da593d43448f168408

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