xarpes 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

xarpes/settings_parameters.py

@@ -0,0 +1,30 @@
+# Copyright (C) 2025 xARPES Developers
+# This program is free software under the terms of the GNU GPLv3 license.
+
+"""User-configurable numerical parameters for xARPES."""
+
+# Extend data range by this many Gaussian sigmas
+sigma_extend = 5.0
+
+# Gaussian confidence level expressed in "sigma"
+sigma_confidence = 2.0
+
+def parameter_settings(new_sigma_extend=None, new_sigma=None):
+    """
+    Configure global numerical parameters for xARPES.
+
+    Parameters
+    ----------
+    new_sigma_extend : float or None
+        Number of Gaussian sigmas used to extend arrays before convolution.
+    new_sigma : float or None
+        Gaussian confidence level expressed in units of sigma
+        (e.g. 1, 2, 3). Default is 2.
+    """
+    global sigma_extend, sigma_confidence
+
+    if new_sigma_extend is not None:
+        sigma_extend = float(new_sigma_extend)
+
+    if new_sigma is not None:
+        sigma_confidence = float(new_sigma)

xarpes/settings_plots.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2025 xARPES Developers
+# This program is free software under the terms of the GNU GPLv3 license.
+
+"""Plotting and notebook behaviour settings for xARPES."""
+
+import matplotlib.pyplot as plt
+
+def plot_settings(name="default", register_pre_run=True):
+    """Configure default plotting style for xARPES.
+
+    Parameters
+    ----------
+    name : {"default", "large"}
+        Select a predefined style.
+    register_pre_run : bool
+        If True, register a Jupyter pre-run hook that closes figures.
+    """
+    import matplotlib as mpl
+
+    mpl.rc("xtick", labelsize=10, direction="in")
+    mpl.rc("ytick", labelsize=10, direction="in")
+    plt.rcParams["legend.frameon"] = False
+    lw = dict(default=2.0, large=4.0)[name]
+
+    mpl.rcParams.update({
+        "lines.linewidth": lw,
+        "lines.markersize": 3,
+        "xtick.major.size": 4,
+        "xtick.minor.size": 2,
+        "xtick.major.width": 0.8,
+        "font.size": 16,
+        "axes.ymargin": 0.15,
+    })
+
+    if register_pre_run:
+        _maybe_register_pre_run_close_all()
+
+
+def _maybe_register_pre_run_close_all():
+    """Register a pre_run_cell hook once, and only inside Jupyter."""
+    from IPython import get_ipython
+
+    if getattr(_maybe_register_pre_run_close_all, "_registered", False):
+        return
+
+    ip = get_ipython()
+    if ip is None or ip.__class__.__name__ != "ZMQInteractiveShell":
+        return
+
+    def _close_all(_info):
+        plt.close("all")
+
+    ip.events.register("pre_run_cell", _close_all)
+    _maybe_register_pre_run_close_all._registered = True

{xarpes-0.4.0.dist-info → xarpes-0.5.0.dist-info}/METADATA

@@ -1,13 +1,12 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: xarpes
-Version: 0.4.0
+Version: 0.5.0
 Summary: Extraction from angle resolved photoemission spectra
 Author: xARPES Developers
 Requires-Python: >=3.7.0
 Description-Content-Type: text/markdown
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python :: 3
-License-File: LICENSE
 Requires-Dist: igor2>=0.5.8
 Requires-Dist: jupyterlab
 Requires-Dist: jupytext
@@ -33,7 +32,9 @@ This project is currently undergoing **beta testing**. Some of the functionaliti
 
 # Contributing
 
-Contributions to the code are most welcome. xARPES is intended to co-develop alongside the increasing complexity of experimental ARPES data sets. Contributions can be made by forking the code and creating a pull request. Importing of file formats from different beamlines is particularly encouraged. Files useful for developers can be found in `/dev_tools`, such as the `Rmd2py.py` script for the development of examples.
+Contributions to the code are most welcome. xARPES is intended to co-develop alongside the increasing complexity of experimental ARPES data sets. Contributions can be made by forking the code and creating a pull request. Importing of file formats from different beamlines is particularly encouraged. For development of the examples, the following scripts in `/dev_tools` could be useful:
+- The `Rmd2ipynb.py` file, to generate the `.ipynb` from which the examples can conveniently be developed; to be executed after cloning/pulling updated `.Rmd` and `.py` files, or if you prefer developing with `.Rmd` files.
+- The `ipynb2Rmd2py.py` file, to synchronise the `.Rmd` and `.py` files from the `.ipynb` file; to be executed right before pushing modifications to the repository. Note that this script resets some metadata in the `.Rmd` to prevent the tracking of their changes due to local virtual environments, etc.
 
 # Installation
 

xarpes-0.5.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+xarpes/__init__.py,sha256=ZcX2N--vv1R2afnf7UkFZ-ScTCbnyktDs7-MU9D0aaM,756
+xarpes/bandmap.py,sha256=izeL19ohznmBsphaf7LFsIf9lQzbKA7p48gC3b9sedM,31920
+xarpes/constants.py,sha256=XOdgSzyrmHr5xocHZfmcFHHoVAa1G05a305hm3XOTtY,504
+xarpes/distributions.py,sha256=pC8V5MlZDNFdooMonFREEASiN5QodHiyKc2ehnxMKvQ,23498
+xarpes/functions.py,sha256=KEgRs0_OFzyf40M6Tg7bwWOdjjeJX_K9lSDkGKhhS-4,14566
+xarpes/mdcs.py,sha256=Df1Yd3B3rfu6nL1KcnReAwRuxB5ag8wmhyR8gICQZtQ,41097
+xarpes/plotting.py,sha256=lGCReHcXhYLQXR5ns3EHFjCQjJ9Sc-HifV7n4BnWby4,5189
+xarpes/selfenergies.py,sha256=9rGECk7lX64--aAd_-5gvLA4lhD2bRTVHY03PVkd3Xs,21568
+xarpes/settings_parameters.py,sha256=P2_uZC4VUUIzrTVwjqbeSHWtEssRXjUQZbTmfX3ROis,923
+xarpes/settings_plots.py,sha256=X-qteB2fIbBKOAcLMvMYDfQ8QdlUeA5xYQqF_Nyb4uA,1562
+xarpes-0.5.0.dist-info/entry_points.txt,sha256=917UR-cqFTMMI_vMqIbk7boYSuFX_zHwQlXKcj9vlCE,79
+xarpes-0.5.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+xarpes-0.5.0.dist-info/WHEEL,sha256=jPMR_Dzkc4X4icQtmz81lnNY_kAsfog7ry7qoRvYLXw,81
+xarpes-0.5.0.dist-info/METADATA,sha256=4HY_kT0eFmWmTJrHaM-duP_Ih3P2eT6DomcBj_ZFEv8,6996
+xarpes-0.5.0.dist-info/RECORD,,

{xarpes-0.4.0.dist-info → xarpes-0.5.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: flit 3.12.0
+Generator: flit 3.6.0
 Root-Is-Purelib: true
 Tag: py3-none-any