:dragon: 蜻蜓核心库
项目描述
蜻蜓核心
Dragonfly 是 Python 库的集合,用于按照 Dragonfly -schema创建建筑物的表示。它抽象了蜜蜂核心的功能, 以便更容易地在城市规模上构建模型。
这个仓库是提供dragonfly常用功能的核心仓库。要扩展这些功能,您应该安装可用的 Dragonfly 扩展或编写自己的扩展。
以下是 Dragonfly 的一些常用扩展:
- Dragonfly -energy:为 Dragonfly 添加能量模拟。
安装
pip install -U dragonfly-core
要检查 Dragonfly 命令行界面是否安装正确dragonfly viz,请使用您应该得到viiiiiiiiiiiiizzzzzzzzz!回复!
API 文档
地方发展
- 在本地克隆这个 repo
git clone git@github.com:ladybug-tools/dragonfly-core.git
# or
git clone https://github.com/ladybug-tools/dragonfly-core.git
- 安装依赖项:
cd dragonfly-core
pip install -r dev-requirements.txt
pip install -r requirements.txt
- 运行测试:
python -m pytests tests/
- 生成文档:
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly
sphinx-build -b html ./docs ./docs/_build/docs