下载与安装#

本部分是对IFTS仿真平台代码包安装的步骤说明，请按照以下步骤进行IFTS代码包的安装。

下载包#

首先请登录网站后下载发布的对应版本的压缩包，获取其中的IFTS代码包（后缀名为 .tar.gz）

提醒

本智能光传输仿真平台支持IFTS包及源码两种方式的下载，此处教程为IFTS包的导入与使用说明。若使用者想要了解更多细节和内部代码，请在登陆网站后下载源代码，配合IFTS用户手册进行阅读与使用。

通过pip命令安装包#

IFTS包在Windows、Linux和Mac系统中均支持使用，下面对在系统中使用pip命令安装IFTS进行说明。

提醒

目前IFTS包暂不支持在线下载与安装，因此使用者须登录网站下载IFTS包后进行本地安装。

因此在本地安装时，需注意修改导入的文件路径。

Windows系统#

Windows系统中，IFTS包的安装可以通过pip以实现代码包的本地安装。

首先在命令提示符cmd命令中将文件路径导入 代码包所下载的位置，然后利用pip指令进行本地安装：

cd "C:\Users\usr\Downloads\"
pip install IFTS-0.1.tar.gz

命令行中会显示安装的进程，并在完成后提示安装完成，如下所示。

Processing c:\users\usr\downloads\ifts-0.1.tar.gz
  Preparing metadata (setup.py) ... done
Building wheels for collected packages: IFTS
  Building wheel for IFTS (setup.py) ... done
  Created wheel for IFTS: filename=IFTS-0.1-py3-none-any.whl size=117692 sha256=cbf9c0e82278dbabeb8156c1489ce895ea45079baed3f9d6cc1900f451b6a33d
  Stored in directory: c:\users\usr\appdata\local\pip\cache\wheels\43\38\36\a883799a7ebda3daad95b0ce1c3e1dd8a09ce38fff4085e586
Successfully built IFTS
Installing collected packages: IFTS
Successfully installed IFTS-0.1

这将会把IFTS代码包安装在当前Python环境的Python包目录文件夹下。

如需想要安装在某一指定目录下，请使用如下命令将代码包安装在指定路径path_name下：

pip install --target=path_name IFTS-0.1.tar.gz

至此，IFTS代码包已经安装完成，可以使用如下命令查看IFTS包的安装位置与信息：

pip show IFTS

此时，命令行中会显示IFTS包的相关信息与安装位置，如下所示。

Name: IFTS
Version: 0.1
Summary: 智能光传输仿真平台
Home-page: https://ifibertrans.sjtu.edu.cn
Author: 上海交通大学智能光纤系统实验室
Author-email: fibertrans@outlook.com
License: GNU General Public License v3
Location: c:\users\usr\appdata\local\packages\python310\site-packages
Requires: pyyaml, scipy, seaborn, sklearn, torch, tqdm
Required-by:

Linux系统#

Linux系统中，IFTS包的安装也通过pip以实现代码包的本地安装。

将IFTS包下载至Linux系统文件夹中，然后可以通过终端命令进行包安装。首先打开IFTS包所在文件夹，然后利用pip进行安装：

usr@ssh:~$ cd /home/usr/code/
usr@ssh:~/code$ pip install IFTS-0.1.tar.gz

终端会显示安装的进程，并在完成后提示安装完成，如下所示。

Processing ./IFTS-0.1.tar.gz
Building wheels for collected packages: IFTS
  Building wheel for IFTS (setup.py) ... done
  Created wheel for IFTS: filename=IFTS-0.1-py3-none-any.whl size=117712 sha256=54bd72f433c9d5a0d78f33fe0e77b962d29225785d110206f378c0719f7d6e6f
  Stored in directory: /home/usr/.cache/pip/wheels/d3/ea/33/6c7c5e941ec4beba060e0dfc6071bc2d62bac23c29e3f479fa
Successfully built IFTS
Installing collected packages: IFTS
Successfully installed IFTS-0.1

IFTS包安装完成后，可以使用命令查看IFTS包的安装位置与信息：

usr@ssh:~/code$ pip show IFTS

此时，终端中会显示IFTS包的相关信息与安装位置，如下所示。

Name: IFTS
Version: 0.1
Summary: 智能光传输仿真平台
Home-page: https://ifibertrans.sjtu.edu.cn
Author: 上海交通大学智能光纤系统实验室
Author-email: fibertrans@outlook.com
License: GNU General Public License v3
Location: /home/usr/anaconda3/envs/code/lib/python3.8/site-packages
Requires: pyyaml, scipy, seaborn, sklearn, torch, tqdm
Required-by:

Mac系统#

首先登录网站并下载IFTS包至本地，在Mac终端中打开IFTS包所在路径，然后利用pip进行安装：

(base) usr@MacBook ~ % cd /Users/usr/Desktop
(base) usr@MacBook Desktop % pip install IFTS-0.1.tar.gz

终端会显示安装的进程，并在完成后提示安装完成，如下所示。

Processing ./IFTS-0.1.tar.gz
Building wheels for collected packages: IFTS
  Building wheel for IFTS (setup.py) ... done
  Created wheel for IFTS: filename=IFTS-0.1-py3-none-any.whl size=117777 sha256=d0ecafa4d11627b03fd02e81978be90b440a661a42bc3a83bfec47ea17069f1f
  Stored in directory: /Users/Liuwei/Library/Caches/pip/wheels/6e/99/49/791e7ad53895bef4e3faa1a3ef7de015d3b2452e0ef9b67c07
Successfully built IFTS
Installing collected packages: IFTS
Successfully installed IFTS-0.1

IFTS包安装完成后，可以使用命令查看IFTS包的安装位置与信息：

(base) usr@MacBook Desktop % pip show IFTS

此时，终端中会显示IFTS包的相关信息与安装位置，如下所示。

Name: IFTS
Version: 0.1
Summary: 智能光传输仿真平台
Home-page: https://ifibertrans.sjtu.edu.cn
Author: 上海交通大学智能光纤系统实验室
Author-email: fibertrans@outlook.com
License: GNU General Public License v3
Location: /Users/usr/opt/anaconda3/lib/python3.9/site-packages
Requires: pyyaml, scipy, seaborn, sklearn, torch, tqdm
Required-by:

提示

若用户已下载和使用Anaconda，只需先激活用户所使用的环境，即可在conda环境下使用pip命令按照以上步骤进行IFTS的安装。

通过其他方式安装包#

在部分情况下，使用者可能无法使用pip命令进行包的安装。为此，我们也提供了另外一种方式通过python命令直接进行包的安装。

首先用户仍需登录网站并下载IFTS包，然后使用解压软件解压IFTS包，将解压得到的文件（例如./IFTS-0.1）放入当前使用的python环境存放包的目录下。之后使用者可以进入该目录，利用如下命令即可进行安装：

cd /usr/lib/python3.7/site-packages/IFTS-0.1/
python setup.py install

下一步将进行IFTS代码包的参数配置，以便您能够实际运行和使用本智能光传输仿真平台。