跳转到主要内容

OpenFisca-France-Data模块,用于处理法国调查数据

项目描述

OpenFisca France Data

Newsletter Twitter Slack Coveralls Python PyPi

[EN] 简介

OpenFisca是一款多功能的微模拟免费软件。您可以查看在线文档以获取更多详细信息。

本存储库包含OpenFisca-France-Data模块,用于与OpenFisca-France以及法国调查或人口数据(ERFS和ERFS-FPR)协同工作。

以下是管理数据的列表

  • DADS,年度社会数据申报;
  • ERFS,税收和社会收入调查;
  • ERFS-FPR,ERFS生产和研究文件;
  • FELIN,所得税抽样文件。

要将您的调查数据转换为OpenFisca-France-Data格式,您需要从openfisca-survey-manager存储库开始。

[FR] 简介

OpenFisca是一个开源的微观模拟软件。更多信息,请参阅官方文档

本存储库包含OpenFisca-France-Data模块。它允许您使用OpenFisca-France关联到法国的调查或人口数据。

以下是处理的数据列表

  • DADS,年度社会数据申报;
  • ERFS,税收和社会收入调查;
  • ERFS-FPR,ERFS生产和研究文件;
  • FELIN,所得税抽样文件。

为了将您的调查数据转换为OpenFisca-France-Data格式,您需要从openfisca-survey-manager存储库开始。

环境

OpenFisca-France-Data在Python 3.7及更高版本上运行。较新版本的Python应该也可以工作,但尚未经过测试。

自2019年1月1日起已取消对Python 2.7的向后兼容性。

安装

使用conda安装

自版本0.22.0起,您可以使用conda来安装OpenFisca-France-Data。

Conda是Windows上使用OpenFisca的最简单方法,通过安装Anaconda,您将获得

如果您熟悉命令行,可以使用Miniconda,它需要的磁盘空间比Anaconda少得多。

安装conda后,在Anaconda Powershell Prompt中运行以下命令

  • conda create --name openfisca python=3.9 创建名为openfisca的环境。
  • conda activate openfisca 使用您的新环境。

然后,根据您的使用情况选择以下选项之一

  • conda install -c conda-forge -c openfisca openfisca-france-data用于默认依赖项,
  • 或者如果您想贡献到项目中,请使用conda install -c conda-forge -c openfisca openfisca-france-data-test

有关如何发布到conda的信息,请参阅.conda/README.md

开发安装

如果您想要运行OpenFisca-France-Data脚本、开发并贡献源代码,请遵循以下安装说明。欢迎加入!:)

  • 运行OpenFisca-France-Data脚本,
  • 开发并贡献到OpenFisca-France-Data源代码。请欢迎!:)

您需要在本地下载并安装该模块

git clone https://github.com/openfisca/openfisca-france-data.git
cd openfisca-france-data
make install

此过程不应显示任何错误并结束于

成功安装OpenFisca-France-Data...

由于Windows处理长路径的特殊性,请注意以下细节

在Windows机器上,由于Windows默认不处理长路径名,Openfisca-France-Data的安装可能会遇到问题。这些长路径主要继承自OpenFisca-France参数,这些参数有时存储在深层嵌套的文件夹中。

Windows >= 10的一个可能解决方案是取消最大路径长度限制(如此处所示)。

执行

假设您想要将ERFS-FPR调查数据格式化为OpenFisca格式数据。

💡如果您由openfisca-france-data管理的其他数据(如FELIN),在下一步说明中,将erfs_fpr替换为您数据的名称。

您已经使用过openfisca-survey-manager。因此,您有一个为此调查配置的config.ini文件,以及一个在您的config.ini文件下output_directory定义的目录中生成的HDF5文件。

有关更多信息,您可以在openfisca-survey-manager的配置步骤中查看README

要在ERFS-FPR调查数据上运行openfisca_france_data

  1. 运行以下命令

    build-erfs-fpr -y 2013 -f dummy_data.h5
    

    您可以将 2013更改为您感兴趣的任何年份,并将dummy_data.h5更改为您想要导出的任何文件名以导出平坦的数据框。

    脚本应无错误结束并显示以下这些行

    INFO:__main__:Script finished after...
    Closing remaining open files...
    
  2. 检查脚本结果

    • 在您在config.ini中配置的目录下生成了openfisca_erfs_fpr.json文件,在collections_directory键下。
    • 在您在config.ini中配置的目录下生成了input.h5文件,在output_directory键下。此HDF5文件包含一个包含两个项目的组
      • 一个包含您的数据,根据OpenFisca-France Individu实体组织的数据项,
      • 一个包含您的数据,根据OpenFisca-France Menage实体组织的数据项。
    • 仅针对ERFS-FPR脚本:如果保留了export_flattened_df_filepath选项的值,则dummy_data.h5

    脚本还为您添加了openfisca_erfs_fpr密钥到您的config.ini

测试

要运行整个测试套件

make test

风格

此存储库遵循一定的编码风格,我们邀请您遵循它,以便您的贡献能够迅速集成。

要运行风格检查器

make check-style

要自动格式化您的代码更改

make format-style

要自动格式化您的代码更改,每次您提交时

touch .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

tee -a .git/hooks/pre-commit << END
#!/bin/sh
#
# Automatically format your code before committing.
exec make format-style
END

项目详情


下载文件

下载适用于您的平台文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分发

openfisca_france_data-3.6.1.tar.gz (185.8 kB 查看哈希值)

上传时间 源代码

构建分发

OpenFisca_France_Data-3.6.1-py3-none-any.whl (218.9 kB 查看哈希值)

上传时间 Python 3

由以下支持