不错的cx python包括一个客户机和一个数据模型。
ndex2-performance的Python项目详细描述
#**ndex2 client v1.0**
\**概述**
ndex2 client v1.0 python模块提供了通过ndex服务器api访问ndex的方法。它还提供了网络上常见操作的方法。它包括nicecx网络对象类，用于方便的ndex访问，并作为应用程序的数据模型。
客户端%20v1.0%20tutorial.ipynb）
*使用nicecx网络类：[nicecx v1.0教程]（https://github.com/ndexbio/ndex jupyter notebooks/blob/master/notebooks/nicecx%20v1.0%20tutorial.ipynb）
要使用这些教程，请克隆[ndex jupyter notebooks存储库]（https://github.com/ndexbio/ndex jupyter笔记本）到本地计算机，并在项目目录中启动jupyter笔记本。
以及用于安装的pip python包管理器的最新版本。[单击此处]（https://pypi.python.org/pypi/pip）下载pip python包。
\ADY安装了旧版本的ndex2模块，可以改用此命令：
>；pip install--upgrade ndex2
\ndex2 client objects**
ndex2 client提供了一个到ndex服务器的接口，该服务器通过client object类进行管理。可以使用ndex2客户机对象匿名或使用特定的用户帐户访问ndex服务器。对于要在脚本或应用程序中使用的每个ndex服务器和用户帐户，创建一个ndex2客户机实例。在本例中，创建一个客户端对象以访问公共ndex服务器。
``
import ndex2.client
anon-ndex=ndex2.client.ndex2（"http://public.ndexbio.org"）
````
使用特定用户帐户的客户端对象可以执行需要身份验证的操作，例如保存netwo我的账户是我的账户，我的密码是我的密码，我的账户是我的账户，我的账户是我的账户，我的密码是我的密码，我的账户，我的密码，我的客户端，ndx2（"http://public.ndexbio.org"，我的账户，我的密码"）是我的账户，我的密码，我的客户端，我的密码，我的账户，我的密码，
``````
更新状态（）**
*用ndex服务器的状态更新client object*status*属性。
用户尚未验证计数，返回对象将不包含用户uuiid，*isverified*字段将为假。
\\\35\\353535\\\35\\3535\35\353535\\35\\\ **拯救_cx_stream_as_new_network（cx_stream）**
*从字节流cx_stream创建网络。
与经过身份验证的用户拥有或具有写权限的ndex服务器上的现有网络相对应。
*如果cx_u流数据大于ndex服务器允许的最大大小，则会出错。
由网络标识指定。
*没有撤消删除的方法，因此应小心。
*指定的网络必须由经过身份验证的用户拥有。
#####**get_network_summary（network_id）**
*从network_id指定的网络检索networksummary json对象，并将其作为python dict返回。
*networksummary对象提供有关网络的有用信息，这是网络配置文件信息（在网络cx的特殊方面表示的属性）的混合物，网络属性（在网络cx的网络属性方面表示的属性）和网络系统属性（表示网络如何存储在服务器上，而不是网络cx的一部分的属性）。
<；table>；
<；tr>；
<；td>；属性<；td>；
<；td>；说明<；td>；
<；td>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；gt；lt；lt；lt；lt；gt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt网络的文本描述，与dc:d含义相同关于网络边缘对象的数量；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；错误消息<；td>；
<；td>；如果此网络不是有效的CX网络，此字段保留由CX网络验证器生成的错误消息。lt；lt；td>；
<；lt；td>；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；td>；
><；lt；lt；lt><；lt；gt；lt；lt；lt；lt；lt>；lt；lt；td>；
>；
<；lt；lt；td>；
<；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt>；
<；lt；td>；is deleted<；lt；lt；td>；如果网络被标记为已删除，则lt；lt；lt；lt；td>；true；如果网络被标记为已删除，则lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；
<；/tr>；
<；lt；tr>；
<；td>；issshowccase<；lt；td>；
<；lt；lt；td>；如果网络显示则为真；lt；lt；lt；lt；td>；如果网络显示则为真；lt；lt；lt；td>；
<；lt；td>；布尔值<；lt；lt；td>；
<；tr>；
<；lt；tr>；
<；lt；lt；lt；tr>；
<；lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；布尔型<；/td>；
<；/tr>；
<；lt；tr>；
<；td>；网络上次修改的时间；lt；td>；
<；lt；td>；网络最后一次修改的时间；lt；lt；td>；
<；lt；td>；网络上次修改的时间；lt；td>；
<；lt；td>；lt；lt；lt；lt；lt；tr>；
<；lt；tr>；
>；
>；
>；lt；lt；lt；lt>；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；br/><gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt>；网络所有者的用户名<；td>；
<；lt；td>；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt>；ndexpropertyValuePair对象列表：描述特性网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络t的；td>；uri<；td>；
<；td>；uri当前网络格式t不受控制，但最佳做法是使用符合语义版本控制的字符串，即公共或私有的字符串。public意味着任何人都可以找到或读取它，包括匿名用户。Private是默认设置，这意味着用户只能根据自己的权限来查找或读取它，
<；td>；string<；td>；
<；tr>；
<；tr>；
<；td>；警告<；td>；
<；td>；cx网络生成的警告消息列表有效ator<；/td>；
<；td>；list<；/td>；
<；/tr>；
<；/table>；
**
*上表中的**properties**属性表示一个属性列表，其中每个属性是一个字典，包含以下字段：
<；table>；
<；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt是的/><；tr>；
<；tr>；
<；td>；谓词字符串<；td>；
<；td>；属性名称。
<；tr>；
<；tr>；
<；td>；值<；td>；
<；td>；属性值<；td>；
<；td>；
>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt如果网络不是t找到，或者如果经过身份验证的用户没有网络的读取权限。
*匿名用户只能访问visibility=public的网络。
*这是作为一个整体操作执行的，因此通常建议应用程序在检索网络之前首先使用getnetworksummary方法检查网络的节点和边缘计数。
ies）**
*为网络ID指定的网络设置网络系统属性数据中指定的系统属性。
*网络系统属性描述网络在NDEX服务器上的状态，但不是相应的CX网络对象的一部分。
*.0支持的系统属性为：
*只读：布尔值
*可见性：公共或私有。
*显示：布尔值。控制网络是否显示在经过身份验证的用户的主页上。如果用户没有对网络的显式权限，则返回错误。
*network_system_properties format:{property:value，…}，例如：
*{"readonly"：true}
*{"visibility"："public"}
*{"showcase"：true}
*{"readonly"：true，"visibility"："private"，"showcase"：false}。
set_network_system_properties方法：
*set_network_system_properties（network_id，{"visibility"："private"}）。
使用set_network_system_properties方法对公共网络的可见性：
*set_network_system_properties（network_id，{"visibility"："public"}）.
方法：
*设置网络系统属性（网络ID，{"只读"：true}）
*设置网络系统属性（网络ID，{"只读"：false}）。
由网络ID指定的网络的组ID标识。
*权限将更新为权限参数（读、写或管理）中指定的值。
*如果发出请求的经过身份验证的用户对指定的n没有写或管理权限，则会出现错误。网络。
*如果网络ID与现有网络不对应，则出现错误。
*如果操作将在没有任何具有管理权限的用户的情况下离开网络，则出现错误：ndex不允许网络在没有任何所有者的情况下成为"孤儿"。
*更新由group_id指定的组对network_id list中指定的所有网络的权限
*对于每个网络，权限将更新为permission参数中指定的值。权限参数是读、写或管理；默认值是读。
*如果发出请求的经过身份验证的用户没有对每个网络的写或管理权限，则出错。
*如果任何网络标识与现有网络不对应，则出错。
*它将使任何网络没有任何具有管理权限的用户：ndex不允许网络在没有任何所有者的情况下成为"孤儿"。
由网络ID指定的网络。
*权限将更新为权限参数中指定的值。权限参数是读、写或管理。
*如果发出请求的经过身份验证的用户没有对指定网络的写或管理权限，则为错误。
*如果网络ID与现有网络不对应，则为错误。
*如果将离开网络，则为错误。k没有任何具有管理权限的用户：ndex不允许网络在没有任何所有者的情况下成为"孤儿"。
工作ID。
*此方法相当于通过按用户名获取用户ID，然后使用该用户ID调用更新网络用户权限。
由用户标识为网络标识列表中指定的所有网络指定。
*指定的任何配置文件属性都将被更新，但未指定的属性将不起作用-删除属性并不意味着删除该属性。
*此方法可以更新的网络配置文件属性包括"名称"、"说明"和"版本".
R/>*N中的许多网络dex没有子网络，在这种情况下，不应**设置每个ndexpropertyValuePair的subnetworkID属性。
*某些网络（包括从cytoscape保存的某些网络）有一个子网络。在这些情况下，每个ndexpropertyValuePair都应将**subnetworkID属性设置为该子网络的ID**。
*源自Cytoscape Desktop的其他网络对应于Cytoscape"集合"，并且可能具有多个子网。每个子网可能都有与之关联的ndexpropertyvaluepairs，这些将在cytoscape网络查看器中可见。集合本身可能具有与其关联的ndexpropertyValuePairs，这些在cytoscape网络查看器中不可见，但可以由特定的cytoscape应用程序设置或读取。在这些情况下，**强烈建议您在Cytoscape**中而不是通过此API编辑这些网络属性，除非您非常熟悉Cytoscape数据模型。
*ndExpropertyValuePair对象具有以下属性：
<；table>；
<；tr>；
<；td>；属性<；/td>；
<；td>；说明<；/td>；
<；td>；键入<；/td>；
<；/tr>；
<；tr>；
<；td>；子网id<；/td>；
<；td>；属性适用的子网的可选标识符。<；/td>；
<；td>；字符串<；/td>；此属性的数据类型。它的值必须是cx支持的属性数据类型之一。<；td>；
<；td>；字符串<；td>；
<；tr>；
<；tr>；
<；td>；值<；td>；
<；td>；属性值的字符串表示形式。<；td>；
<；td>；字符串<；td>；>；<
<；/tr>；
<；/table>；
****
*如果经过身份验证的用户没有指定网络的管理权限，则出错。
*如果网络ID与现有网络不对应，则出错。
*返回由网络标识指定的网络的来源方面。
*请参阅文档[ndex来源历史]（http://www.home.ndexbio.org/network-provenance-history/）以了解此结构的详细说明及其使用的最佳实践。
*如果网络标识不存在错误对应于现有网络。
*返回值是对应于json provenanceentity对象的python dict：
*provenance history是包含provenanceentity和provenanceevent对象的树结构。它被ndex api序列化为json结构。
*树结构的根是表示网络当前状态的provenanceEntity对象。
*每个provenanceEntity可能有一个表示前一个事件t的provenanceEvent对象。产生起源实体的帽子。反过来，链接到provenanceEvent和provenanceEntity对象的网络，这些对象表示生成网络当前状态的工作流历史。
*在复制、修改或创建网络时，provenance历史记录重要事件，其中包括信息的快照关于"祖先"网络的信息。
*provenanceentity中的属性：
**uri*：provenanceentity描述的资源的uri。在某些情况下，将不会设置此字段，例如文件上载或生成网络的算法事件，而没有以前的网络作为输入
**creationevent*：provenanceevent。具有prov:wasgenetedby properties:simplePropertyValuePair对象数组的语义
*provenanceEvent中的属性：
**endedataTime*：时间戳。塞曼蒂cs of prov:endedattime
**startedattime*：时间戳。具有prov:endedattime
**inputs*：provenanceEntity对象数组的语义。具有prov:used的语义。
**properties*：simplePropertyValuePair数组。
t.
*provenance参数用于表示网络的当前状态和历史，并包含描述网络起源历史的provenanceEvent和provenanceEntity对象的树结构。
*对指定网络的权限。
*如果网络ID与现有网络不对应，则出错。
包含：
*网络摘要对象数组（网络）
*搜索的总命中计数（numfound）
*返回元素的位置（start）
*search_string参数指定搜索字符串。
**deprecated**：帐户名为opt是，但已被搜索字符串字段**useradmin:account_name**取代。如果提供了该字段，则搜索将被限制到该帐户拥有的网络。
*start和size参数是可选的。默认值为start=0和size=100。
*可选的include_groups参数默认为false。它允许搜索返回一个网络，其中一个组具有访问该网络的权限，并且用户是该组的成员。如果include_group s为true，则搜索还将基于来自已验证用户的组成员身份的权限返回网络。
*find_networks方法是不推荐使用的搜索_networks替代名称。
account_name=none，start=0，size=100）**
*不推荐使用此方法；应改用搜索网络。
搜索计数（numfound）
*返回的元素（start）在由count_name参数指定的用户中的位置。
*找到的networksummary对象的数量限制为（不超过）1000。
*此函数不会返回组具有权限的网络登录以访问网络，帐户名是组的成员。
*此函数相当于调用搜索网络（""，帐户名，大小=1000）。
AME参数。找到的网络ID数限制为（不超过）1000。
*此函数相当于为用户调用get_network_summaries_（""，account_name，size=1000），然后生成调用返回的网络ID列表，以为用户get_network_summaries_。
八字节流作为cx流（网络id，搜索字符串，搜索深度=1，边缘限制=2500）*
*返回网络cx字节流，该网络cx字节流是由网络id指定的网络子集（邻域）。
*到由搜索深度指定的深度。
*edge嫒limit指定此查询可以返回的最大边数。
*如果结果中的边数大于edge嫒limit参数，服务器将返回错误。
环，搜索深度=1，边缘极限=2500）**
*参数和行为与get_neighborhood_as_cx_cx_cx_cx_cx_cx_x stream相同，但返回与网络cx-json对象对应的python dict。
35 35 35 35 35<
35
*如果找不到任务或验证用户没有拥有指定的任务。
**nicecx对象**
**节点**
**create_node（name，represents=none）*
节点。最佳实践是使用标准命名空间中的id，并在网络上下文中定义命名空间前缀。
**添加节点（节点）**
向网络添加节点对象。
**node**：节点对象（nicecxmodel.cx.aspects.nodeselement）
**设置节点属性（节点、属性名称、值、类型=无、子网=无）**
对象。
***节点**：节点对象或节点id
***属性名称**：属性名称
***值**：属性值的值或值列表
***类型**：属性值的数据类型，默认为值的python数据类型。
***子网络**：应用此属性的子网络的ID。
**获取_节点属性（节点，属性名称，子网络=无）**
es.
**获取节点属性对象（节点，属性名称）**
节点属性对象包括数据类型和子网信息。包含子网络的网络的一个示例是存储在ndex中的cytoscape集合。
**node**：节点对象或节点id
**attribute廑name**：attribute name
**get廑node廑attributes（node）**
节点对象或节点id
**get_nodes（）**
d或节点对象本身。
**target**：此边缘的目标节点，其ID或节点对象本身。
**interaction**：描述源节点和目标节点之间关系的交互
**add_edge（edge）**
add edge对象到网络。
**edge**：边缘对象（nicecxmodel.cx.aspects.edgeselement）
**set_edge_attribute（edge，attribute_name，value s，type=none，subnetwork=none）**
但是，值，默认为值的python数据类型。
**subnetwork**：应用此属性的子网络的ID。
**get_edge_attribute（edge，attribute_name，subnetwork=none）**
get the value of a attribute of a edge，where the edge may be specified by its id or passed in as object.
**edGE**：边缘对象或边缘ID
***属性名称**：属性名称
***子网络**：子网络的ID（如果任何）应用此属性的对象。
**获取边缘属性对象（边缘，属性名称）**
获取边缘属性名称的属性对象，其中边缘可以由其ID指定或作为对象传入。边缘属性对象包括数据类型和子网信息。包含子网络的网络的一个示例是存储在ndex中的cytoscape集合。
**edge**：节点对象或节点id
**attribute-name**：attribute-name
**get-edge-attributes（edge）**
id或作为对象传入。
**edge**：edge对象或edge id
**get_edges（）**
返回一个迭代器，它将edge id作为键，edge对象作为值。
设置网络名称
**get summary（）**
获取网络摘要
**设置网络属性（名称=无，值=无，类型=无，子网ID=无）**
/>***类型**：属性值的数据类型
**subnetwork**：此属性适用的子网的ID（如果有）。
**get_network_attribute（attribute_name，subnetwork_id=none）**
get the value of a network attribute
**attribute_name**：attribute name
***子网**：应用此属性的子网（如果有）的ID。
**获取网络属性对象（属性名称）**
属性对象包括数据类型和子网信息。包含子网络的网络的一个示例是存储在ndex中的cytoscape集合。
**get_network_attributes（）**
>获取网络的属性对象。
**get_metadata（）**
*获取网络元数据
**set_metadata（）**
*设置网络metadata
**get provenance（）**
*将网络源代码作为具有cx源代码模式的python字典获取。
**设置源代码（provenance）**
*设置网络源代码
**获取上下文（context）**
将命名空间前缀映射到其定义的uri的ect设置网络的@context方面，将命名空间前缀映射到其定义的uri的方面_name
（nicecxmodel.cx.aspectelement.aspectelement）
**aspect-name**：要检索的方面的名称。
**设置不透明方面（aspect-name，aspect-elements）**
将aspect-name指定的方面设置为方面元素列表。如果aspect廑元素为none，则删除aspect。
（nicecxmodel.cx.aspectelement.aspectelement）
**get廑opaque廑aspect廑names（）**
*获取所有不透明方面的名称
\i/o**
**到廑cx（）**
*返回与网络对应的cx。
**to_cx_stream（）**
返回与网络对应的cx流。可用于发送到可接受流输入的终结点
**到_networkx（）**
返回基于网络的networkx图。网络CarteSianCoordinates方面的元素将转换为networkx**pos**属性。
**到熊猫数据帧（）**
>将网络导出为熊猫数据帧。
示例：my_nicecx.upload廑到（uuid='34f29fd1-884b-11e7-a10d-0ac135e8bacf'，server='http://test.ndexbio.org'，username='myusername'，password='mypassword'）
**上载（ndex廑服务器，username，password，update廑uuid=none）**
由用户名和密码指定的帐户，返回undex上网络的uid。
示例：my_nicecx.upload嫒to（'http://test.ndexbio.org'，'my username'，'my password'）
*服务器：要将网络上载到的ndex服务器。
*用户名：要存储网络的帐户的用户名
*密码：帐户的密码。
*更新uuid：不是创建新网络，而是用nicecx对象的内容更新具有此uuid的网络。
**应用模板（服务器、用户名、密码、uuid）**
r**：将从中复制布局的网络的ndex服务器主机
**username**：启用对专用网络的访问的可选用户名
**password**：启用对专用网络的访问的可选密码
**uuid**：从中布局将被复制到
节点的表示。这可用于存储节点的规范化id
**json_obj**：节点的cx表示
**add_edge_element（json_obj=none，edge）**
low level function
**json_obj**：边的cx表示
**addnetworkattribute（json_obj=none）**
\**概述**
ndex2 client v1.0 python模块提供了通过ndex服务器api访问ndex的方法。它还提供了网络上常见操作的方法。它包括nicecx网络对象类，用于方便的ndex访问，并作为应用程序的数据模型。
客户端%20v1.0%20tutorial.ipynb）
*使用nicecx网络类：[nicecx v1.0教程]（https://github.com/ndexbio/ndex jupyter notebooks/blob/master/notebooks/nicecx%20v1.0%20tutorial.ipynb）
要使用这些教程，请克隆[ndex jupyter notebooks存储库]（https://github.com/ndexbio/ndex jupyter笔记本）到本地计算机，并在项目目录中启动jupyter笔记本。
以及用于安装的pip python包管理器的最新版本。[单击此处]（https://pypi.python.org/pypi/pip）下载pip python包。
\ADY安装了旧版本的ndex2模块，可以改用此命令：
>；pip install--upgrade ndex2
\ndex2 client objects**
ndex2 client提供了一个到ndex服务器的接口，该服务器通过client object类进行管理。可以使用ndex2客户机对象匿名或使用特定的用户帐户访问ndex服务器。对于要在脚本或应用程序中使用的每个ndex服务器和用户帐户，创建一个ndex2客户机实例。在本例中，创建一个客户端对象以访问公共ndex服务器。
``
import ndex2.client
anon-ndex=ndex2.client.ndex2（"http://public.ndexbio.org"）
````
使用特定用户帐户的客户端对象可以执行需要身份验证的操作，例如保存netwo我的账户是我的账户，我的密码是我的密码，我的账户是我的账户，我的账户是我的账户，我的密码是我的密码，我的账户，我的密码，我的客户端，ndx2（"http://public.ndexbio.org"，我的账户，我的密码"）是我的账户，我的密码，我的客户端，我的密码，我的账户，我的密码，
``````
更新状态（）**
*用ndex服务器的状态更新client object*status*属性。
用户尚未验证计数，返回对象将不包含用户uuiid，*isverified*字段将为假。
\\\35\\353535\\\35\\3535\35\353535\\35\\\ **拯救_cx_stream_as_new_network（cx_stream）**
*从字节流cx_stream创建网络。
与经过身份验证的用户拥有或具有写权限的ndex服务器上的现有网络相对应。
*如果cx_u流数据大于ndex服务器允许的最大大小，则会出错。
由网络标识指定。
*没有撤消删除的方法，因此应小心。
*指定的网络必须由经过身份验证的用户拥有。
#####**get_network_summary（network_id）**
*从network_id指定的网络检索networksummary json对象，并将其作为python dict返回。
*networksummary对象提供有关网络的有用信息，这是网络配置文件信息（在网络cx的特殊方面表示的属性）的混合物，网络属性（在网络cx的网络属性方面表示的属性）和网络系统属性（表示网络如何存储在服务器上，而不是网络cx的一部分的属性）。
<；table>；
<；tr>；
<；td>；属性<；td>；
<；td>；说明<；td>；
<；td>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；gt；lt；lt；lt；lt；gt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt网络的文本描述，与dc:d含义相同关于网络边缘对象的数量；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；错误消息<；td>；
<；td>；如果此网络不是有效的CX网络，此字段保留由CX网络验证器生成的错误消息。lt；lt；td>；
<；lt；td>；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；td>；
><；lt；lt；lt><；lt；gt；lt；lt；lt；lt；lt>；lt；lt；td>；
>；
<；lt；lt；td>；
<；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt>；
<；lt；td>；is deleted<；lt；lt；td>；如果网络被标记为已删除，则lt；lt；lt；lt；td>；true；如果网络被标记为已删除，则lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；
<；/tr>；
<；lt；tr>；
<；td>；issshowccase<；lt；td>；
<；lt；lt；td>；如果网络显示则为真；lt；lt；lt；lt；td>；如果网络显示则为真；lt；lt；lt；td>；
<；lt；td>；布尔值<；lt；lt；td>；
<；tr>；
<；lt；tr>；
<；lt；lt；lt；tr>；
<；lt；lt；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；布尔型<；/td>；
<；/tr>；
<；lt；tr>；
<；td>；网络上次修改的时间；lt；td>；
<；lt；td>；网络最后一次修改的时间；lt；lt；td>；
<；lt；td>；网络上次修改的时间；lt；td>；
<；lt；td>；lt；lt；lt；lt；lt；tr>；
<；lt；tr>；
>；
>；
>；lt；lt；lt；lt>；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；br/><gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt>；网络所有者的用户名<；td>；
<；lt；td>；lt；lt；lt；td>；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt>；ndexpropertyValuePair对象列表：描述特性网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络的网络t的；td>；uri<；td>；
<；td>；uri当前网络格式t不受控制，但最佳做法是使用符合语义版本控制的字符串，即公共或私有的字符串。public意味着任何人都可以找到或读取它，包括匿名用户。Private是默认设置，这意味着用户只能根据自己的权限来查找或读取它，
<；td>；string<；td>；
<；tr>；
<；tr>；
<；td>；警告<；td>；
<；td>；cx网络生成的警告消息列表有效ator<；/td>；
<；td>；list<；/td>；
<；/tr>；
<；/table>；
**
*上表中的**properties**属性表示一个属性列表，其中每个属性是一个字典，包含以下字段：
<；table>；
<；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt是的/><；tr>；
<；tr>；
<；td>；谓词字符串<；td>；
<；td>；属性名称。
<；tr>；
<；tr>；
<；td>；值<；td>；
<；td>；属性值<；td>；
<；td>；
>；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；gt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt；lt如果网络不是t找到，或者如果经过身份验证的用户没有网络的读取权限。
*匿名用户只能访问visibility=public的网络。
*这是作为一个整体操作执行的，因此通常建议应用程序在检索网络之前首先使用getnetworksummary方法检查网络的节点和边缘计数。
ies）**
*为网络ID指定的网络设置网络系统属性数据中指定的系统属性。
*网络系统属性描述网络在NDEX服务器上的状态，但不是相应的CX网络对象的一部分。
*.0支持的系统属性为：
*只读：布尔值
*可见性：公共或私有。
*显示：布尔值。控制网络是否显示在经过身份验证的用户的主页上。如果用户没有对网络的显式权限，则返回错误。
*network_system_properties format:{property:value，…}，例如：
*{"readonly"：true}
*{"visibility"："public"}
*{"showcase"：true}
*{"readonly"：true，"visibility"："private"，"showcase"：false}。
set_network_system_properties方法：
*set_network_system_properties（network_id，{"visibility"："private"}）。
使用set_network_system_properties方法对公共网络的可见性：
*set_network_system_properties（network_id，{"visibility"："public"}）.
方法：
*设置网络系统属性（网络ID，{"只读"：true}）
*设置网络系统属性（网络ID，{"只读"：false}）。
由网络ID指定的网络的组ID标识。
*权限将更新为权限参数（读、写或管理）中指定的值。
*如果发出请求的经过身份验证的用户对指定的n没有写或管理权限，则会出现错误。网络。
*如果网络ID与现有网络不对应，则出现错误。
*如果操作将在没有任何具有管理权限的用户的情况下离开网络，则出现错误：ndex不允许网络在没有任何所有者的情况下成为"孤儿"。
*更新由group_id指定的组对network_id list中指定的所有网络的权限
*对于每个网络，权限将更新为permission参数中指定的值。权限参数是读、写或管理；默认值是读。
*如果发出请求的经过身份验证的用户没有对每个网络的写或管理权限，则出错。
*如果任何网络标识与现有网络不对应，则出错。
*它将使任何网络没有任何具有管理权限的用户：ndex不允许网络在没有任何所有者的情况下成为"孤儿"。
由网络ID指定的网络。
*权限将更新为权限参数中指定的值。权限参数是读、写或管理。
*如果发出请求的经过身份验证的用户没有对指定网络的写或管理权限，则为错误。
*如果网络ID与现有网络不对应，则为错误。
*如果将离开网络，则为错误。k没有任何具有管理权限的用户：ndex不允许网络在没有任何所有者的情况下成为"孤儿"。
工作ID。
*此方法相当于通过按用户名获取用户ID，然后使用该用户ID调用更新网络用户权限。
由用户标识为网络标识列表中指定的所有网络指定。
*指定的任何配置文件属性都将被更新，但未指定的属性将不起作用-删除属性并不意味着删除该属性。
*此方法可以更新的网络配置文件属性包括"名称"、"说明"和"版本".
R/>*N中的许多网络dex没有子网络，在这种情况下，不应**设置每个ndexpropertyValuePair的subnetworkID属性。
*某些网络（包括从cytoscape保存的某些网络）有一个子网络。在这些情况下，每个ndexpropertyValuePair都应将**subnetworkID属性设置为该子网络的ID**。
*源自Cytoscape Desktop的其他网络对应于Cytoscape"集合"，并且可能具有多个子网。每个子网可能都有与之关联的ndexpropertyvaluepairs，这些将在cytoscape网络查看器中可见。集合本身可能具有与其关联的ndexpropertyValuePairs，这些在cytoscape网络查看器中不可见，但可以由特定的cytoscape应用程序设置或读取。在这些情况下，**强烈建议您在Cytoscape**中而不是通过此API编辑这些网络属性，除非您非常熟悉Cytoscape数据模型。
*ndExpropertyValuePair对象具有以下属性：
<；table>；
<；tr>；
<；td>；属性<；/td>；
<；td>；说明<；/td>；
<；td>；键入<；/td>；
<；/tr>；
<；tr>；
<；td>；子网id<；/td>；
<；td>；属性适用的子网的可选标识符。<；/td>；
<；td>；字符串<；/td>；此属性的数据类型。它的值必须是cx支持的属性数据类型之一。<；td>；
<；td>；字符串<；td>；
<；tr>；
<；tr>；
<；td>；值<；td>；
<；td>；属性值的字符串表示形式。<；td>；
<；td>；字符串<；td>；>；<
<；/tr>；
<；/table>；
****
*如果经过身份验证的用户没有指定网络的管理权限，则出错。
*如果网络ID与现有网络不对应，则出错。
*返回由网络标识指定的网络的来源方面。
*请参阅文档[ndex来源历史]（http://www.home.ndexbio.org/network-provenance-history/）以了解此结构的详细说明及其使用的最佳实践。
*如果网络标识不存在错误对应于现有网络。
*返回值是对应于json provenanceentity对象的python dict：
*provenance history是包含provenanceentity和provenanceevent对象的树结构。它被ndex api序列化为json结构。
*树结构的根是表示网络当前状态的provenanceEntity对象。
*每个provenanceEntity可能有一个表示前一个事件t的provenanceEvent对象。产生起源实体的帽子。反过来，链接到provenanceEvent和provenanceEntity对象的网络，这些对象表示生成网络当前状态的工作流历史。
*在复制、修改或创建网络时，provenance历史记录重要事件，其中包括信息的快照关于"祖先"网络的信息。
*provenanceentity中的属性：
**uri*：provenanceentity描述的资源的uri。在某些情况下，将不会设置此字段，例如文件上载或生成网络的算法事件，而没有以前的网络作为输入
**creationevent*：provenanceevent。具有prov:wasgenetedby properties:simplePropertyValuePair对象数组的语义
*provenanceEvent中的属性：
**endedataTime*：时间戳。塞曼蒂cs of prov:endedattime
**startedattime*：时间戳。具有prov:endedattime
**inputs*：provenanceEntity对象数组的语义。具有prov:used的语义。
**properties*：simplePropertyValuePair数组。
t.
*provenance参数用于表示网络的当前状态和历史，并包含描述网络起源历史的provenanceEvent和provenanceEntity对象的树结构。
*对指定网络的权限。
*如果网络ID与现有网络不对应，则出错。
包含：
*网络摘要对象数组（网络）
*搜索的总命中计数（numfound）
*返回元素的位置（start）
*search_string参数指定搜索字符串。
**deprecated**：帐户名为opt是，但已被搜索字符串字段**useradmin:account_name**取代。如果提供了该字段，则搜索将被限制到该帐户拥有的网络。
*start和size参数是可选的。默认值为start=0和size=100。
*可选的include_groups参数默认为false。它允许搜索返回一个网络，其中一个组具有访问该网络的权限，并且用户是该组的成员。如果include_group s为true，则搜索还将基于来自已验证用户的组成员身份的权限返回网络。
*find_networks方法是不推荐使用的搜索_networks替代名称。
account_name=none，start=0，size=100）**
*不推荐使用此方法；应改用搜索网络。
搜索计数（numfound）
*返回的元素（start）在由count_name参数指定的用户中的位置。
*找到的networksummary对象的数量限制为（不超过）1000。
*此函数不会返回组具有权限的网络登录以访问网络，帐户名是组的成员。
*此函数相当于调用搜索网络（""，帐户名，大小=1000）。
AME参数。找到的网络ID数限制为（不超过）1000。
*此函数相当于为用户调用get_network_summaries_（""，account_name，size=1000），然后生成调用返回的网络ID列表，以为用户get_network_summaries_。
八字节流作为cx流（网络id，搜索字符串，搜索深度=1，边缘限制=2500）*
*返回网络cx字节流，该网络cx字节流是由网络id指定的网络子集（邻域）。
*到由搜索深度指定的深度。
*edge嫒limit指定此查询可以返回的最大边数。
*如果结果中的边数大于edge嫒limit参数，服务器将返回错误。
环，搜索深度=1，边缘极限=2500）**
*参数和行为与get_neighborhood_as_cx_cx_cx_cx_cx_cx_x stream相同，但返回与网络cx-json对象对应的python dict。
35 35 35 35 35<
35
*如果找不到任务或验证用户没有拥有指定的任务。
**nicecx对象**
**节点**
**create_node（name，represents=none）*
节点。最佳实践是使用标准命名空间中的id，并在网络上下文中定义命名空间前缀。
**添加节点（节点）**
向网络添加节点对象。
**node**：节点对象（nicecxmodel.cx.aspects.nodeselement）
**设置节点属性（节点、属性名称、值、类型=无、子网=无）**
对象。
***节点**：节点对象或节点id
***属性名称**：属性名称
***值**：属性值的值或值列表
***类型**：属性值的数据类型，默认为值的python数据类型。
***子网络**：应用此属性的子网络的ID。
**获取_节点属性（节点，属性名称，子网络=无）**
es.
**获取节点属性对象（节点，属性名称）**
节点属性对象包括数据类型和子网信息。包含子网络的网络的一个示例是存储在ndex中的cytoscape集合。
**node**：节点对象或节点id
**attribute廑name**：attribute name
**get廑node廑attributes（node）**
节点对象或节点id
**get_nodes（）**
d或节点对象本身。
**target**：此边缘的目标节点，其ID或节点对象本身。
**interaction**：描述源节点和目标节点之间关系的交互
**add_edge（edge）**
add edge对象到网络。
**edge**：边缘对象（nicecxmodel.cx.aspects.edgeselement）
**set_edge_attribute（edge，attribute_name，value s，type=none，subnetwork=none）**
但是，值，默认为值的python数据类型。
**subnetwork**：应用此属性的子网络的ID。
**get_edge_attribute（edge，attribute_name，subnetwork=none）**
get the value of a attribute of a edge，where the edge may be specified by its id or passed in as object.
**edGE**：边缘对象或边缘ID
***属性名称**：属性名称
***子网络**：子网络的ID（如果任何）应用此属性的对象。
**获取边缘属性对象（边缘，属性名称）**
获取边缘属性名称的属性对象，其中边缘可以由其ID指定或作为对象传入。边缘属性对象包括数据类型和子网信息。包含子网络的网络的一个示例是存储在ndex中的cytoscape集合。
**edge**：节点对象或节点id
**attribute-name**：attribute-name
**get-edge-attributes（edge）**
id或作为对象传入。
**edge**：edge对象或edge id
**get_edges（）**
返回一个迭代器，它将edge id作为键，edge对象作为值。
设置网络名称
**get summary（）**
获取网络摘要
**设置网络属性（名称=无，值=无，类型=无，子网ID=无）**
/>***类型**：属性值的数据类型
**subnetwork**：此属性适用的子网的ID（如果有）。
**get_network_attribute（attribute_name，subnetwork_id=none）**
get the value of a network attribute
**attribute_name**：attribute name
***子网**：应用此属性的子网（如果有）的ID。
**获取网络属性对象（属性名称）**
属性对象包括数据类型和子网信息。包含子网络的网络的一个示例是存储在ndex中的cytoscape集合。
**get_network_attributes（）**
>获取网络的属性对象。
**get_metadata（）**
*获取网络元数据
**set_metadata（）**
*设置网络metadata
**get provenance（）**
*将网络源代码作为具有cx源代码模式的python字典获取。
**设置源代码（provenance）**
*设置网络源代码
**获取上下文（context）**
将命名空间前缀映射到其定义的uri的ect设置网络的@context方面，将命名空间前缀映射到其定义的uri的方面_name
（nicecxmodel.cx.aspectelement.aspectelement）
**aspect-name**：要检索的方面的名称。
**设置不透明方面（aspect-name，aspect-elements）**
将aspect-name指定的方面设置为方面元素列表。如果aspect廑元素为none，则删除aspect。
（nicecxmodel.cx.aspectelement.aspectelement）
**get廑opaque廑aspect廑names（）**
*获取所有不透明方面的名称
\i/o**
**到廑cx（）**
*返回与网络对应的cx。
**to_cx_stream（）**
返回与网络对应的cx流。可用于发送到可接受流输入的终结点
**到_networkx（）**
返回基于网络的networkx图。网络CarteSianCoordinates方面的元素将转换为networkx**pos**属性。
**到熊猫数据帧（）**
>将网络导出为熊猫数据帧。
示例：my_nicecx.upload廑到（uuid='34f29fd1-884b-11e7-a10d-0ac135e8bacf'，server='http://test.ndexbio.org'，username='myusername'，password='mypassword'）
**上载（ndex廑服务器，username，password，update廑uuid=none）**
由用户名和密码指定的帐户，返回undex上网络的uid。
示例：my_nicecx.upload嫒to（'http://test.ndexbio.org'，'my username'，'my password'）
*服务器：要将网络上载到的ndex服务器。
*用户名：要存储网络的帐户的用户名
*密码：帐户的密码。
*更新uuid：不是创建新网络，而是用nicecx对象的内容更新具有此uuid的网络。
**应用模板（服务器、用户名、密码、uuid）**
r**：将从中复制布局的网络的ndex服务器主机
**username**：启用对专用网络的访问的可选用户名
**password**：启用对专用网络的访问的可选密码
**uuid**：从中布局将被复制到
节点的表示。这可用于存储节点的规范化id
**json_obj**：节点的cx表示
**add_edge_element（json_obj=none，edge）**
low level function
**json_obj**：边的cx表示
**addnetworkattribute（json_obj=none）**
欢迎加入QQ群-->： 979659372
