Sail-On 客户端和协议

DARPA sail-on 的客户端和协议

仓库中存在的协议

1. OND
2. CONDDA

需求

1. Python 3.7
2. Poetry >= 1.1.0

安装

1. 按照安装在 安装页面 上的说明安装 Poetry

2. 在工作目录中克隆与不同组件相关联的存储库

     git clone https://github.com/darpa-sail-on/sail-on-client.git
   

   这将在您的工作目录中创建 sail-on-client 目录

3. 在虚拟环境中安装不同的组件

     cd sail-on-client
     poetry install
     poetry shell
   

使用不同算法运行客户端和服务器

注意：如果您使用的是 PAR 安装的服务器，请将 sail_on_client/protocol/configuration.json 中的 url 更改为 http://3.32.8.161:5000，并跳过运行服务器的步骤 1。

1. 运行 M6 算法的说明
2. 运行 M12 算法的说明
3. 运行 M18 算法的说明

在 PyPI 上发布

sail-on-client 使用 github actions 在 PyPI 上发布软件包。当将 semver 标签推送到存储库时，将触发此操作。

我们支持以下版本格式 .. 和 ..-alpha. 用于标签。要在 PyPI 上发布包，标签必须与 pyproject.toml 中维护的版本匹配。这作为工作流程中的强制检查实现。Poetry 提供了对通过 CLI 查询和升级版本的支持。有关详细信息，请参阅 版本。

因此，要在 PyPI 上发布 sail-on-client，请使用以下命令：

1. 使用 poetry version <version_rule> 在 pyproject.toml 中升级版本。
2. 使用 poetry version --short 确定将用于标签的版本。
3. 使用以下命令生成并推送标签：

     git tag <package-version>
     git push origin --tags
   

支持声明和免责声明

本材料基于美国国防部高级研究计划局（DARPA）在合同 No. HR001120C0055 下支持的工作。本材料中表达的意见、发现、结论或建议是作者的观点，并不一定反映 DARPA 的观点。