{"id":30663362,"url":"https://github.com/policyengine/policyengine-ie","last_synced_at":"2025-08-31T17:10:33.183Z","repository":{"id":311532007,"uuid":"1043968487","full_name":"PolicyEngine/policyengine-ie","owner":"PolicyEngine","description":"PolicyEngine Ireland: Microsimulation model for the Irish tax and benefit system","archived":false,"fork":false,"pushed_at":"2025-08-25T03:12:51.000Z","size":209,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-25T04:47:22.953Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://policyengine.github.io/policyengine-ie","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PolicyEngine.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-25T01:41:14.000Z","updated_at":"2025-08-25T03:12:54.000Z","dependencies_parsed_at":"2025-08-25T04:47:42.196Z","dependency_job_id":"5501fa33-4e59-4eee-a4da-6a86ae51b4b8","html_url":"https://github.com/PolicyEngine/policyengine-ie","commit_stats":null,"previous_names":["policyengine/policyengine-ie"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/PolicyEngine/policyengine-ie","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolicyEngine%2Fpolicyengine-ie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolicyEngine%2Fpolicyengine-ie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolicyEngine%2Fpolicyengine-ie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolicyEngine%2Fpolicyengine-ie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PolicyEngine","download_url":"https://codeload.github.com/PolicyEngine/policyengine-ie/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolicyEngine%2Fpolicyengine-ie/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273010994,"owners_count":25030369,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-31T17:10:26.500Z","updated_at":"2025-08-31T17:10:33.171Z","avatar_url":"https://github.com/PolicyEngine.png","language":"Python","readme":"# PolicyEngine Ireland\n\n[![PyPI](https://img.shields.io/pypi/v/policyengine-ie)](https://pypi.org/project/policyengine-ie/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/policyengine-ie)](https://pypi.org/project/policyengine-ie/)\n[![License](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE)\n[![Tests](https://github.com/PolicyEngine/policyengine-ie/actions/workflows/test.yml/badge.svg)](https://github.com/PolicyEngine/policyengine-ie/actions/workflows/test.yml)\n\nPolicyEngine's microsimulation model for the Irish tax and benefit system. This model enables researchers, policymakers, and citizens to analyze the impacts of tax and benefit reforms in Ireland.\n\n## Features\n\n- **Comprehensive Tax System**: Income tax, USC (Universal Social Charge), PRSI (Pay Related Social Insurance), and VAT\n- **Social Security Benefits**: Jobseeker's Allowance/Benefit, State Pension, Child Benefit, Working Family Payment, HAP, and more\n- **Tax Credits System**: Personal, employee, and other tax credits\n- **State-Level Modeling**: Support for different local authorities and rates\n- **Reform Modeling**: Analyze the impact of policy changes on households and society\n\n## Installation\n\n### Prerequisites\n\n- Python 3.10 or higher\n- `uv` package manager (recommended) or `pip`\n\n### Install from PyPI\n\n```bash\npip install policyengine-ie\n```\n\n### Development Installation\n\n```bash\ngit clone https://github.com/PolicyEngine/policyengine-ie.git\ncd policyengine-ie\nmake install\n```\n\n## Quick Start\n\n```python\nfrom policyengine_ie import IrishTaxBenefitSystem\n\n# Create a tax-benefit system\nsystem = IrishTaxBenefitSystem()\n\n# Create a household\nfrom policyengine_core.simulations import Simulation\n\nsimulation = Simulation(system=system)\n\n# Add people\nsimulation.add_person(\n    person_id=\"person_1\",\n    age=35,\n    employment_income=50000,  # €50,000 annual income\n)\n\nsimulation.add_person(\n    person_id=\"person_2\", \n    age=8,  # Child\n)\n\n# Define household structure\nsimulation.add_tax_unit(\n    tax_unit_id=\"tax_unit_1\",\n    adults=[\"person_1\"],\n    children=[\"person_2\"],\n)\n\nsimulation.add_household(\n    household_id=\"household_1\",\n    members=[\"person_1\", \"person_2\"],\n)\n\n# Calculate tax and benefit variables\nincome_tax = simulation.calculate(\"income_tax\", period=\"2024\")\nusc = simulation.calculate(\"usc\", period=\"2024\")\nchild_benefit = simulation.calculate(\"child_benefit\", period=\"2024\")\n\nprint(f\"Income Tax: €{income_tax['person_1']:.2f}\")\nprint(f\"USC: €{usc['person_1']:.2f}\")\nprint(f\"Child Benefit: €{child_benefit['person_2']:.2f}\")\n```\n\n## Tax System Coverage\n\n### Taxes\n- **Income Tax**: Progressive rates (20% standard, 40% higher)\n- **Universal Social Charge (USC)**: Surcharge on income\n- **PRSI (Pay Related Social Insurance)**: Social insurance contributions\n- **VAT**: Value Added Tax (23% standard, 13.5% and 9% reduced rates)\n\n### Benefits \u0026 Social Protection\n- **Jobseeker's Allowance/Benefit**: Unemployment support\n- **State Pension (Contributory)**: Contributory old-age pension  \n- **State Pension (Non-Contributory)**: Non-contributory old-age pension\n- **Child Benefit**: Universal child payment\n- **Working Family Payment**: In-work family support\n- **Housing Assistance Payment (HAP)**: Housing support\n- **Disability Allowance**: Support for disabled individuals\n- **One-Parent Family Payment**: Support for single parents\n- **Carer's Allowance**: Support for carers\n\n### Tax Credits\n- **Personal Tax Credit**: Basic personal allowance\n- **PAYE Tax Credit**: Employee tax credit\n- **Age Tax Credit**: Additional credit for older taxpayers\n- **Incapacitated Child Tax Credit**: Support for families with disabled children\n\n## System Architecture\n\nPolicyEngine Ireland follows the same high-quality architecture as other PolicyEngine models:\n\n```\npolicyengine_ie/\n├── entities.py              # Person, TaxUnit, BenefitUnit, Family, Household\n├── system.py               # Main system class\n├── parameters/             # Policy parameters (YAML files)\n│   └── gov/               # Organized by government department\n│       ├── revenue/       # Revenue Commissioners (taxes)\n│       ├── dsp/          # Dept of Social Protection (benefits)\n│       └── housing/      # Dept of Housing (HAP, etc.)\n├── variables/             # Policy calculations (Python files)\n│   └── gov/              # Same organization as parameters\n├── reforms/              # Pre-defined policy reforms\n└── tests/                # Comprehensive test suite\n```\n\n## Data Sources\n\nAll parameters and calculations are based on official Irish government sources:\n\n- **Revenue Commissioners**: [revenue.ie](https://revenue.ie) - Tax rates, credits, and thresholds\n- **Citizens Information**: [citizensinformation.ie](https://citizensinformation.ie) - Benefit eligibility and rates\n- **Department of Social Protection**: [gov.ie/dsp](https://gov.ie/dsp) - Social welfare payments\n- **Department of Housing**: [gov.ie/housing](https://gov.ie/housing) - Housing supports\n- **Central Statistics Office**: [cso.ie](https://cso.ie) - Economic indicators\n\n## Testing\n\nWe use comprehensive test-driven development:\n\n```bash\n# Run all tests\nmake test\n\n# Run with coverage\nmake test-cov\n\n# Run only policy tests\nmake test-lite\n```\n\n## Documentation\n\nFull documentation is available at [policyengine.org/ie/api](https://policyengine.org/ie/api).\n\nBuild documentation locally:\n\n```bash\nmake documentation\n```\n\n## Contributing\n\nWe welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n### Development Workflow\n\n1. Fork the repository\n2. Create a feature branch\n3. Write tests for your changes\n4. Implement your changes\n5. Run tests and formatting: `make format test`\n6. Submit a pull request\n\n## License\n\nThis project is licensed under the GNU Affero General Public License v3.0 - see [LICENSE](LICENSE) for details.\n\n## Citation\n\nIf you use PolicyEngine Ireland in academic research, please cite:\n\n```bibtex\n@software{policyengine_ireland,\n  title = {PolicyEngine Ireland: A microsimulation model of the Irish tax and benefit system},\n  author = {{PolicyEngine}},\n  url = {https://github.com/PolicyEngine/policyengine-ie},\n  version = {0.1.0},\n  year = {2024}\n}\n```\n\n## Contact\n\n- Website: [policyengine.org](https://policyengine.org)\n- Email: hello@policyengine.org\n- GitHub Issues: [Issues](https://github.com/PolicyEngine/policyengine-ie/issues)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolicyengine%2Fpolicyengine-ie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolicyengine%2Fpolicyengine-ie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolicyengine%2Fpolicyengine-ie/lists"}