xARPES代码的仓库 - 从角分辨光电子能谱中提取。

这个预发布版本只能用于拟合费米能边。完整的功能将很快提供。

安装

xARPES可以使用pip安装

python3 -m pip install xarpes

或者使用conda

conda install conda-forge::xarpes

以下提供了针对最新Ubuntu和Debian GNU/Linux的测试版本更详细的安装说明。

pip

极力推荐设置一个干净的Python虚拟环境。首先，可能需要安装venv模块

sudo apt install python3-venv

之后，可以使用以下命令激活名为<my_venv>的虚拟环境

python3 -m venv <my_venv>

安装/运行xARPES时必须激活

source <my_venv>/bin/activate

推荐将pip升级到最新版本

python3 -m pip install --upgrade pip

最后，可以执行安装

git clone git@github.com:xARPES/xARPES.git
cd xARPES
python3 -m pip install -e .

conda

假设用户在由conda提供的干净虚拟环境中。首先，从https://docs.anaconda.net.cn/free/miniconda/下载适用于您的操作系统的所需版本。例如

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh

开始安装

bash Miniconda3-latest-Linux-x86_64.sh

然后向下滚动许可协议，回答以下问题的 是

Do you accept the license terms? [yes|no]

同时指定您的安装位置。

还可以回答以下问题的 是，这将向您的 ~/.bashrc 添加新行

You can undo this by running `conda init --reverse $SHELL`? [yes|no]

然后通过执行 source ~/.bashrc 或启动新的终端会话来激活 conda 基础环境。

或者，您可以回答上述问题为 否，并在需要时激活 conda

eval "$(<your_path>/miniconda3/bin/conda shell.<your_shell> hook)"

接下来，我们安装 conda-build 用于开发 xARPES（回答问题为 是）

conda install conda-build

最后，执行以下步骤进行安装——运行 xARPES 时需要启动 <my_env> 环境

git clone git@github.com:xARPES/xARPES.git
cd xARPES
conda create -n <my_env> -c defaults -c conda-forge --file requirements.txt
conda activate <my_env>
conda develop .

回答问题为 是。

示例

安装 xARPES 后，可以使用以下命令将 examples/ 文件夹下载到当前目录：

python3 -c "import xarpes; xarpes.download_examples()"

执行

建议使用 JupyterLab 分析数据。使用以下命令启动 JupyterLab：

jupyter lab

许可证

版权（C）2024 xARPES 开发者

本程序是自由软件；您可以根据自由软件基金会发布的 GNU 通用公共许可证的条款 3 进行重新分发或修改。

本程序分发时希望对用户有用，但没有任何保证；甚至没有关于适销性或适用于特定目的的隐含保证。有关详细信息，请参阅 GNU 通用公共许可证。