qdatalib

注意，此项目处于开发中，并将经历大量的重大更改

###待办事项

• 更好的命名
• 导出为csv
• 更好地处理不存在的文件

描述

QDataLib 是围绕 QCoDeS 中一些最有用的“数据”函数的包装库。QDataLib 的想法是使用 MongoDB 数据库跟踪您的数据文件，并简化导出到其他文件格式（而不是 SQLite）的过程

安装

要从源代码安装 QDataLib，请执行以下操作

$ git clone https://github.com/qdev-dk/QDataLib.git
$ cd QDataLib
$ pip install .

用法

请参阅 此处

运行测试

如果您从源代码获取了 'qdatalib'，您可以在本地运行测试。

通过在根目录中执行以下操作，将 qdatalib 以及其测试依赖项安装到您的虚拟环境中

$ pip install .
$ pip install -r test_requirements.txt

然后在 tests 文件夹中运行 pytest。

构建文档

如果您从源代码获取了 qdatalib，您可以在本地构建文档。

通过在根目录中执行以下操作，将 qdatalib 以及其文档依赖项安装到您的虚拟环境中

$ pip install .
$ pip install -r docs_requirements.txt

您还需要安装 pandoc。如果您使用 conda，可以通过以下方式实现

$ conda install pandoc

否则，请参阅 此处 了解 pandoc 的安装说明。

然后在 docs 文件夹中运行 make html。下次构建文档时，请记住在运行 make html 之前运行 make clean。