AIDA交换格式
aida-interchange的Python项目详细描述
AIF Python API
要在项目中使用aida_interchange
包,必须首先安装它。建议您将aida_interchange
安装到python3虚拟环境中。有关创建和使用虚拟环境的详细信息,请参见Python Virtual Environment。在
安装
要安装aida_interchange
,请确保激活了Python Virtual Environment,并运行以下命令:
$ pip install aida-interchange
现在可以将aida_interchange
模块导入到您的项目中。在
API文档
python项目使用Sphinx来生成文档。要生成文档,请确保激活了Python Virtual Environment,导航到AIDA-Interchange-Format/python/docs
目录,然后运行update_documentation.sh
脚本。在
此脚本将生成HTML格式的文档,并将其放在AIDA-Interchange-Format/python/docs/build/html
文件夹中。在
建议在一个称为虚拟环境的独立环境中进行Python开发。有多种方法可以设置和使用Python虚拟环境。本自述描述了其中一种方法。在
基本步骤包括:
- 安装virtualenv(完成一次)
- 创建虚拟环境(每次开发工作完成一次)
- 根据需要重复:
- 激活虚拟环境
- 安装库并开发代码
- 停用虚拟环境
按照以下说明设置虚拟环境。需要注意的是,永远不要在虚拟环境之外安装任何特定于项目的python依赖项。另外,在这个存储库中运行python脚本之前,请确保您的虚拟环境已被激活。在
安装virtualenv
如果您还没有安装virtualenv
,请按照以下步骤操作。这只需要一次。在
$ cd ~
$ mkdir .virtualenvs
$ pip install virtualenv
验证是否安装了virtualenv
$ which virtualenv
创建虚拟环境
当您开始开发python项目时,首先需要创建一个虚拟环境。下面示例中的虚拟环境的名称aida-interchange-format
,假设您正在进行更改或测试AIF库。如果您只是在使用AIF库,请随意使用特定于您的应用程序的名称。在
要创建虚拟环境并安装最新的AIF,请运行以下命令:
$ virtualenv -p python3 ~/.virtualenvs/aida-interchange-format
$ source ~/.virtualenvs/aida-interchange-format/bin/activate
$ pip install aida-interchange
您的虚拟环境现在已激活。以下各节介绍停用和重新激活虚拟环境。在
停用虚拟环境
要停用当前的虚拟环境,请运行以下命令。在
$ deactivate
激活虚拟环境
要重新激活虚拟环境,请运行以下命令。在
$ source ~/.virtualenvs/aida-interchange-format/bin/activate
- 项目
标签: