Skip to main content

a tool for feature

Project description

featureview 使用说明文档

一、软件介绍

  • 名称:featureview
  • 用途:打开录制的 *.MF4 文件,读取并显示里面的变量信息。

二、 安装说明

2.1 测试电脑是否已安装 python3

首先需要确定电脑是否已经安装了 python3,请按如下步骤测试:

  • 打开 cmd
  • 输入: python -V
  • 查看上一步的结果是否是 python2. * . *( *代表任意数字即可)。因为公司有的软件依赖于python2版本,所以这里必须显示为 python 版本为 2. *
  • 输入: pip -V
  • 查看上一步的结果是否显示关联到 python2. * 版本
  • 输入:python3 -V
  • 查看上一步的结果是否显示是python3. *,如果正常,则说明已安装了python3版本
  • 输入:pip3 -V
  • 查看上一步的结果是否显示关联到 python3. *,如果正常,则说明已安装了 pip3并且关联到python3

解释: pip 是python安装外部模块的管理程序。

如果已上都显示正确,可直接跳到 2.5,否则向下依次安装

2.2 安装 python3

  • 前往网址: https://www.python.org/downloads/ 下载python3.7.4的win10安装包。(其它版本未测试)
  • 双击下载下来的安装包 python-3.7.4.exe 进行安装,安装过程中请勾选以下选项: 将python可执行程序添加到路径(add to PATH);安装路径选择本用户,不要使用全局或重新选定路径;其它默认即可。

2.3 解决python2 与 python3 的兼容性问题

  • 进入 python3 的安装路径文件夹中:C:\Users\AppData\Local\Programs\Python\Python37-32, 其中 user-name 是使用帐户名
  • 复制本文件夹内的 python.exe,并粘贴在本文件夹内,并修改粘贴后文件名为 python3.exe.

2.4 测试 python3 安装是否成功

重新按照 2.1中的指令进行测试,如果一切正常则跳到2.5, 否则请联系我。

2.5 安新 featureview 模块

  • 如果电脑联网的话,打开 cmd, 输入指令: pip3 install featureview
  • 如果未联网,可联系我离线安装。

如果网络不好,导致pip3安装模块速度太慢,可以更换国内的清华开源镜像源后安装,参考网址:https://mirrors.tuna.tsinghua.edu.cn/help/pypi/

如果安装正常,可在路径:C:\Users\AppData\Local\Programs\Python\Python37\Scripts 下找到一个文件名为:featureview*.exe ,双击即可打开软件,也可以将此文件创建桌面快捷方式使用。

三、软件打包指令

  • python3 -m pip install --user --upgrade setuptools wheel
  • python3 setup.py sdist bdist_wheel

打包后的文件在dist文件夹下

四、软件开发过程简要说明

3.1 项目托管、发布地址

  • 源代码使用 git 托管在 bitbucket 上的 featureviw 工程下方
  • 软件通过 python 的第三方模块发布网站 PyPI 进行版本的发布、更新和安装,网址在:https://pypi.org/project/featureview/ 。使用 PyPI发布模块可以使用户在安装更新时,仅使用 cmd 一条指令即可简单实现。

注:发布在 PyPI 上的 featureview 模块包是二进制 .whl 文件,源代码不会被外部获取。外部所有人都可以安装这个模块,但是无法获得源代码,而且代码中的数据处理部分使用的语法仅支持 Veoneer 的文件命名法则。

3.2 所用工具、框架

  • 开发语言:python3
  • 图形框架:静态显示采用Qt5(具体是对应于 python 语言的 PyQt5模块), 动态交互采用的是 pyqtgraph 模块。
  • 数据存储:采用支持 sql 语言的本地数据库 sqlite3(无需联网)进行数据的存储、筛选、提取,后期优化也可支持SQL语言联网的 MySQL等开源数据库产品。
  • 数据处理:numpy
  • 读取 MF4 文件外部模块:mdfreader

3.3 部分主要源文件用途

  • setup.py 创建模块打包文件,定义模块的相关打包信息。
  • requirements.txt 本软件所依赖的外部模块,安装时会自动安装些文件的内容。
  • featureviewgui.py 程序的入口地址。
  • constant.py 定义了程序中所使用的一些全局变量,便于后期的修改。
  • data/ 此文件夹包含软件最主要的数据处理文件及未来将要生成的数据库文件。
  • data/data_process.py 此文件定义了本软件中数据处理的核心内容,使用 mdfreader 读取 MF4 文件,并将文件内的信息存储在 sqlite3 里面的数据库中。当软件中某个功能需要数据时,使用 SQL 语法从 sqlite3 里面的数据库中进行筛选提取,提取出的数据使用 numpy 进行数学运算处理。
  • ui/ 此文件夹包含所有的软件前端画面文件,即定义了软件中的按扭布局等。
  • widget/ 此文件夹包含所有与 ui/ 文件夹中对应前端画面文件的后端逻辑实现文件,即定义了用户按压某个按扭之后所进行的操作。

五、本文档说明

  • 版本: v1.0
  • 作者: Andy.Yang
  • 部门: Radar.Feature

六、版本更新说明

  • 1.0.1 修复了一个Bug。由于上一个版本中 requirements.txt 未指定依赖包的版本,导致依赖包更新时某些API被弃用。本次在此文件中指定了开发时的版本
  • 1.0.0 在当前版本下测试正常

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

featureview-1.0.1-py3-none-any.whl (110.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page