用于WebViz的自定义短划线组件
webviz-subsurface-components的Python项目详细描述
WebVIZ地下组件
webviz_subsurface_components
是用于webviz
的短划线组件库
您可以快速开始:
- 运行
pip install webviz-subsurface-components
- 运行
python examples/example_hm.py
- 访问网页浏览器中的http://localhost:8050
贡献
此项目由 dash-component-boilerplate。 它包含创建自定义短划线组件所需的最小代码集。
安装依赖项
如果在提示期间选择了“安装依赖项”,则可以跳过此部分
安装npm包
npm install
创建一个虚拟环境并激活
virtualenv venv . venv/bin/activate
注意:venv\scripts\activate for windows
安装构建组件所需的python包。
pip install .[dependencies] pip install dash[dev]
安装python软件包进行测试(可选)
pip install .[tests] pip install dash[testing]
在src/lib/components/<component_name>.react.js
中编写组件代码
演示应用程序位于
src/demo
中,您将把示例组件代码导入到演示应用程序中。在python环境中测试代码:
- 构建代码
npm run build:all
- 运行并修改
usage.py
示例dash应用程序:python usage.py
- 构建代码
为组件编写测试。
样本测试在
tests/test_usage.py
中可用,它将加载usage.py
然后您就可以自动化与硒的交互。用
pytest tests
运行测试Dash团队广泛使用这些类型的集成测试。 浏览github上的dash组件代码以获取更多测试示例 (例如dash-core-components)。
通过将自定义css文件放入 您的分发文件夹(
webviz_subsurface_components
)。确保它们在
MANIFEST.in
中被引用,以便它们得到 准备发布组件时正确包含确保将样式表添加到
webviz_subsurface_components/__init__.py
所以dash将为他们服务 在请求组件套件时自动执行。
编译代码并安装
- 生成代码:
npm run build:all
- 安装python包:
pip install -e .