xarpes 0.2.4__py3-none-any.whl → 0.6.0__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.
@@ -1,122 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: xarpes
3
- Version: 0.2.4
4
- Summary: Extraction from angle resolved photoemission spectra
5
- Author: xARPES Developers
6
- Requires-Python: >=3.7.0
7
- Description-Content-Type: text/markdown
8
- Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
9
- Classifier: Programming Language :: Python :: 3
10
- Requires-Dist: igor2
11
- Requires-Dist: jupyterlab
12
- Requires-Dist: jupytext
13
- Requires-Dist: matplotlib
14
- Requires-Dist: numpy
15
- Requires-Dist: scipy
16
- Requires-Dist: lmfit
17
- Requires-Dist: xarray
18
- Requires-Dist: pyqt5
19
- Project-URL: Documentation, https://xarpes.github.io
20
-
21
- ![xARPES](https://xarpes.github.io/_images/xarpes.svg)
22
-
23
- Repository for the code xARPES – extraction from angle resolved photoemission spectra.
24
-
25
- This preliminary release can only be used to fit a Fermi edge. The complete functionality will be made available soon.
26
-
27
- # Installation
28
-
29
- xARPES can be installed with `pip`:
30
-
31
- python3 -m pip install xarpes
32
-
33
- Or with `conda`:
34
-
35
- conda install conda-forge::xarpes
36
-
37
- More detailed instructions for installing the development version, tested for recent Ubuntu and Debian GNU/Linux, are provided below.
38
-
39
- ## pip
40
-
41
- It is highly recommended to set up a pristine Python virtual environment. First, the `venv` module might have to be installed:
42
-
43
- sudo apt install python3-venv
44
-
45
- Afterwards, one can activate a virtual environment named `<my_venv>` using:
46
-
47
- python3 -m venv <my_venv>
48
-
49
- It has to be activated whenever installing/running xARPES:
50
-
51
- source <my_venv>/bin/activate
52
-
53
- It is recommended to upgrade `pip` to the latest version:
54
-
55
- python3 -m pip install --upgrade pip
56
-
57
- Finally, the installation can be performed:
58
-
59
- git clone git@github.com:xARPES/xARPES.git
60
- cd xARPES
61
- python3 -m pip install -e .
62
-
63
- ## conda
64
-
65
- The user is assumed to be in a pristine virtual environment provided by conda. First, download the required version for your operating system from <https://docs.anaconda.com/free/miniconda/>. For example:
66
-
67
- wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
68
-
69
- Start the installation:
70
-
71
- bash Miniconda3-latest-Linux-x86_64.sh
72
-
73
- Then scroll down the license agreement and answer `yes` to the following question:
74
-
75
- Do you accept the license terms? [yes|no]
76
-
77
- Also specify your installation location.
78
-
79
- It is convenient to also answer `yes` to the following, which will append new lines to your `~/.bashrc`:
80
-
81
- You can undo this by running `conda init --reverse $SHELL`? [yes|no]
82
-
83
- A conda base environment is then activated with `source ~/.bashrc` or by starting a new terminal session.
84
-
85
- Alternatively, you can answer `no` to the above question and activate conda whenever you need it:
86
-
87
- eval "$(<your_path>/miniconda3/bin/conda shell.<your_shell> hook)"
88
-
89
- Next, we install `conda-build` for developing xARPES (answer `y` to questions):
90
-
91
- conda install conda-build
92
-
93
- Finally, the following steps are executed for the installation &ndash; the `<my_env>` environment will have to be launched whenever running xARPES:
94
-
95
- git clone git@github.com:xARPES/xARPES.git
96
- cd xARPES
97
- conda create -n <my_env> -c defaults -c conda-forge --file requirements.txt
98
- conda activate <my_env>
99
- conda develop .
100
-
101
- Answer `y` to questions.
102
-
103
- # Examples
104
-
105
- Afer installation of xARPES, the `examples/` folder can be downloaded to the current directory with
106
-
107
- python3 -c "import xarpes; xarpes.download_examples()"
108
-
109
- # Execution
110
-
111
- It is recommended to use JupyterLab to analyse data. JupyterLab is launched using:
112
-
113
- jupyter lab
114
-
115
- # License
116
-
117
- Copyright (C) 2024 xARPES Developers
118
-
119
- 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.
120
-
121
- 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.
122
-
@@ -1,10 +0,0 @@
1
- xarpes/__init__.py,sha256=WD-CqxsgBL8lK0Cv_uMuRSprM2iV0mwJxclRvmgNxbU,149
2
- xarpes/band_map.py,sha256=jLmGJe7WmDGP7nV2ekEua5mzDZ6JuobZ9-XG7WM48YA,10402
3
- xarpes/distributions.py,sha256=mfh_OJPFXq1H1_SYtB3qLyxe4CJCl-aKhdNQkjIHBrE,15148
4
- xarpes/functions.py,sha256=mQxOh2CEPSDcjGxStBnpQXe3aJOdLkgrjsQacv1wXJs,4624
5
- xarpes/plotting.py,sha256=vGCF9-v1YzxdSRYMAkl0HwsZiG3eG_CWpf4WdZ4s3hU,5405
6
- xarpes/.ipynb_checkpoints/__init__-checkpoint.py,sha256=Xi1H3Jn5vt_8WQhSTRqb9hSBhv12fTXEnQrKVdkFGcw,148
7
- xarpes-0.2.4.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
8
- xarpes-0.2.4.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
9
- xarpes-0.2.4.dist-info/METADATA,sha256=WoXPKwGrRLQUMOskZv2QMx0vIcThcjl6J6yFKGBqck8,3910
10
- xarpes-0.2.4.dist-info/RECORD,,