Ryven 项目使用教程

Ryven 项目使用教程

RyvenFlow-based visual scripting for Python项目地址:https://gitcode.com/gh_mirrors/ry/Ryven

1. 项目的目录结构及介绍

Ryven 项目的目录结构如下：

~/ryven/
├── nodes/
│   ├── your_nodes_pkg_1/
│   │   ├── nodes.py
│   │   └── gui.py
│   └── ...
├── saves/
│   ├── your_project_1.json
│   └── ...
└── ryven.cfg

目录结构介绍

• nodes/：存放自定义节点包的目录。每个节点包包含 nodes.py 和 gui.py 文件，分别定义节点逻辑和节点界面。
• saves/：存放项目保存文件的目录。每个项目保存为一个 .json 文件。
• ryven.cfg：全局配置文件，包含 Ryven 的配置选项。

2. 项目的启动文件介绍

Ryven 项目的启动文件是 ryven，可以通过命令行启动：

ryven

如果 Ryven 安装在 Python 虚拟环境或 conda 环境中，需要先激活环境：

source activate your_env_name
ryven

3. 项目的配置文件介绍

Ryven 的配置文件是 ryven.cfg，位于用户主目录下的 ~/ryven/ 目录中。配置文件可以通过以下四种方式进行配置：

命令行配置

ryven --nodes your_nodes_pkg_1 --no-animations

配置文件配置

在 ryven.cfg 文件中添加配置项：

nodes = your_nodes_pkg_1
no_animations = True

集成到其他 Python 应用中

import ryven
ryven.run_ryven(nodes=['your_nodes_pkg_1'], no_animations=True)

使用启动对话框配置

在启动对话框中，可以将手动配置转换为命令行参数或配置文件。

可用选项

可以通过 ryven --help 查看所有可用选项。

以上是 Ryven 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 Ryven 项目。

RyvenFlow-based visual scripting for Python项目地址:https://gitcode.com/gh_mirrors/ry/Ryven