xarpes 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
xarpes/__init__.py CHANGED
@@ -1,6 +1,6 @@
1
- __version__ = '0.3.0'
1
+ __version__ = '0.3.2'
2
2
 
3
3
  from .spectral import *
4
4
  from .distributions import *
5
5
  from .functions import *
6
- from .plotting import *
6
+ from .plotting import *
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: xarpes
3
- Version: 0.3.0
3
+ Version: 0.3.2
4
4
  Summary: Extraction from angle resolved photoemission spectra
5
5
  Author: xARPES Developers
6
6
  Requires-Python: >=3.7.0
@@ -17,6 +17,7 @@ Requires-Dist: scipy
17
17
  Requires-Dist: lmfit
18
18
  Requires-Dist: pyqt5
19
19
  Requires-Dist: ipympl
20
+ Requires-Dist: ipykernel<6.32.0
20
21
  Project-URL: Documentation, https://xarpes.github.io
21
22
 
22
23
  # xARPES
@@ -35,7 +36,7 @@ Contributions to the code are most welcome. xARPES is intended to co-develop alo
35
36
 
36
37
  # Installation
37
38
 
38
- xARPES can be installed in several ways depending on your workflow:
39
+ xARPES installation can be divided into graphical package manager instructions, and command-line instructions for either conda or pip. With command-line instructions, an editable installation of xARPES can be created; on Windows, we strongly recommend Windows Powershell to do so. Here is a summary for the three options:
39
40
  - via a graphical package manager (Anaconda Navigator, VS Code, PyCharm, Spyder, JupyterLab)
40
41
  - via conda-forge, out-of-the-box or editable installation, sourcing the [conda-forge package](https://anaconda.org/conda-forge/xarpes).
41
42
  - via Pip, out-of-the-box or editable installation, sourcing the [PyPI package](https://pypi.org/project/xarpes).
@@ -89,14 +90,19 @@ Create and activate an environment:
89
90
 
90
91
  ### Installing xARPES
91
92
 
92
- #### Option A — User installation (from conda-forge)
93
+ #### Option A — Out-of-the-box installation (from conda-forge)
93
94
 
94
95
  conda install conda-forge::xarpes
95
96
 
96
- #### Option B — Developer installation (GitHub, editable)
97
+ #### Option B — Editable installation (GitHub)
98
+
99
+ First, clone the repository:
97
100
 
98
101
  git clone git@github.com:xARPES/xARPES.git
99
- cd xARPES
102
+ cd xARPES
103
+
104
+ Then perform editable installation (this mixes conda and pip):
105
+
100
106
  pip install -e .
101
107
 
102
108
  ## Pip installation
@@ -120,25 +126,26 @@ Upgrade pip:
120
126
 
121
127
  ### Installing xARPES
122
128
 
123
- #### Option A — User installation (PyPI)
129
+ #### Option A — Out-of-the-box installation (PyPI)
124
130
 
125
131
  python3 -m pip install xarpes
126
132
 
127
- #### Option B — Developer installation (GitHub, editable)
133
+ #### Option B — Editable installation (GitHub)
134
+
135
+ First, clone the repository:
128
136
 
129
137
  git clone git@github.com:xARPES/xARPES.git
130
- cd xARPES
131
- python3 -m pip install -e .
138
+ cd xARPES
132
139
 
133
- # Examples
140
+ Then perform editable installation:
134
141
 
135
- After installation of xARPES, the `examples/` folder can be downloaded to the current directory:
142
+ pip install -e .
136
143
 
137
- xarpes_download_examples
144
+ # Examples
138
145
 
139
- Equivalently:
146
+ After installation of xARPES, the `examples/` folder can be downloaded to the current directory:
140
147
 
141
- python3 -c "import xarpes; xarpes.download_examples()"
148
+ python -c "import xarpes; xarpes.download_examples()"
142
149
 
143
150
  # Execution
144
151
 
@@ -158,3 +165,4 @@ Copyright (C) 2025 xARPES Developers
158
165
  This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 3, as published by the Free Software Foundation.
159
166
 
160
167
  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
168
+
@@ -1,11 +1,11 @@
1
- xarpes/__init__.py,sha256=w-VIJOW1owG2XHnWYT9vJerM_YH-FkhK-HdiDNbpPIc,124
1
+ xarpes/__init__.py,sha256=Wk8mY-vjImFwBLPPzg2ot_LCJ5sA0yrffNQy3Ik-hq8,125
2
2
  xarpes/constants.py,sha256=vQxxFeCdGIxMpdh5XGbeRbn7-HF1d5snWkR09d8spGc,587
3
3
  xarpes/distributions.py,sha256=svzhvf994_5gndJA1M04SW4MVfHEVwiAumbhO5Jj22s,23434
4
4
  xarpes/functions.py,sha256=gE76z-Y9UI1KNUUtADyLziLU1UJ43E1CHLDi_khj0bc,12007
5
5
  xarpes/plotting.py,sha256=W-5WaKjBtg8PIxTypqja2R29mgWkQ844lgRWci0nhn0,5679
6
6
  xarpes/spectral.py,sha256=qw0qSeYfaCc9C28cGe32QrI3mK64KNcoNTDkS5EplmM,78637
7
- xarpes-0.3.0.dist-info/entry_points.txt,sha256=917UR-cqFTMMI_vMqIbk7boYSuFX_zHwQlXKcj9vlCE,79
8
- xarpes-0.3.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
9
- xarpes-0.3.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
10
- xarpes-0.3.0.dist-info/METADATA,sha256=v1gBQmF0wbdq8tVQtWHHIK3KgVIYTtxH9w4mkYS1Jms,5378
11
- xarpes-0.3.0.dist-info/RECORD,,
7
+ xarpes-0.3.2.dist-info/entry_points.txt,sha256=917UR-cqFTMMI_vMqIbk7boYSuFX_zHwQlXKcj9vlCE,79
8
+ xarpes-0.3.2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
9
+ xarpes-0.3.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
10
+ xarpes-0.3.2.dist-info/METADATA,sha256=jDXUPvkEx1obDPPHmlSbR32gZ3oTJnd5V6MlPu6HgSk,5763
11
+ xarpes-0.3.2.dist-info/RECORD,,
File without changes