Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ repos:
name: Validate JSON/YAML files against schema
entry: check-jsonschema
language: python
files: ^(tests/ttsim/mettsim|src/_gettsim)/.*\.(yaml|yml)$
files: ^src/_gettsim/.*\.(yaml|yml)$
args:
- --schemafile=src/ttsim/params-schema.json
- --schemafile=docs/geps/params-schema.json
ci:
autoupdate_schedule: monthly
2 changes: 1 addition & 1 deletion CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Title = {{The German Taxes and Transfers SIMulator}},
Author = {{GETTSIM team}},
Year = {2022},
Url = {https://github.com/iza-institute-of-labor-economics/gettsim}
Url = {https://github.com/ttsim-dev/gettsim}
}
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
![PyPI - Version](https://img.shields.io/pypi/v/gettsim)
[![image](https://img.shields.io/conda/vn/conda-forge/gettsim.svg)](https://anaconda.org/conda-forge/gettsim)
[![image](https://img.shields.io/conda/pn/conda-forge/gettsim.svg)](https://anaconda.org/conda-forge/gettsim)
[![main](https://github.com/iza-institute-of-labor-economics/gettsim/actions/workflows/main.yaml/badge.svg)](https://github.com/iza-institute-of-labor-economics/gettsim/actions/workflows/main.yaml)
[![image](https://codecov.io/gh/iza-institute-of-labor-economics/gettsim/branch/main/graph/badge.svg)](https://codecov.io/gh/iza-institute-of-labor-economics/gettsim)
[![main](https://github.com/ttsim-dev/gettsim/actions/workflows/main.yaml/badge.svg)](https://github.com/ttsim-dev/gettsim/actions/workflows/main.yaml)
[![image](https://codecov.io/gh/ttsim-dev/gettsim/branch/main/graph/badge.svg)](https://codecov.io/gh/ttsim-dev/gettsim)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/iza-institute-of-labor-economics/gettsim/main.svg)](https://results.pre-commit.ci/latest/github/iza-institute-of-labor-economics/gettsim/main)
[![image](https://img.shields.io/github/contributors/iza-institute-of-labor-economics/gettsim.svg)](https://github.com/iza-institute-of-labor-economics/gettsim/graphs/contributors)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ttsim-dev/gettsim/main.svg)](https://results.pre-commit.ci/latest/github/ttsim-dev/gettsim/main)
[![image](https://img.shields.io/github/contributors/ttsim-dev/gettsim.svg)](https://github.com/ttsim-dev/gettsim/graphs/contributors)
[![image](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![image](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://gettsim.zulipchat.com)

<p align="center">
<br>
<br>
<a href="https://github.com/iza-institute-of-labor-economics/gettsim/">
<a href="https://github.com/ttsim-dev/gettsim/">
<img src="docs/_static/images/gettsim_logo_text.png" width="800" alt="GETTSIM">
</a>
<br>
Expand Down
1 change: 0 additions & 1 deletion conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
from typing import TYPE_CHECKING

import pytest

from ttsim.interface_dag_elements.backend import dnp as ttsim_dnp
from ttsim.interface_dag_elements.backend import xnp as ttsim_xnp

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
extlinks = {
"ghuser": ("https://github.com/%s", "@%s"),
"gh": (
"https://github.com/iza-institute-of-labor-economics/gettsim/pull/%s",
"https://github.com/ttsim-dev/gettsim/pull/%s",
"#%s",
),
}
Expand All @@ -108,7 +108,7 @@
html_logo = "_static/images/gettsim_logo.svg"

html_theme_options = {
"github_url": "https://github.com/iza-institute-of-labor-economics/gettsim",
"github_url": "https://github.com/ttsim-dev/gettsim",
}

# Add any paths that contain custom static files (such as style sheets) here, relative
Expand Down
6 changes: 3 additions & 3 deletions docs/geps/gep-00.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,14 +239,14 @@ This document has been placed in the public domain.

[^id3]: This historical record is available by the normal git commands for retrieving older
revisions, and can also be browsed on
[GitHub](https://github.com/iza-institute-of-labor-economics/gettsim/tree/main/docs/geps).
[GitHub](https://github.com/ttsim-dev/gettsim/tree/main/docs/geps).

[^id4]: The URL for viewing GEPs on the web is
<https://gettsim.readthedocs.io/en/latest/geps>.

[#geps]: https://gettsim.zulipchat.com/#narrow/stream/309998-GEPs
[github pull request]: https://github.com/iza-institute-of-labor-economics/gettsim/pulls
[repository]: https://github.com/iza-institute-of-labor-economics/gettsim
[github pull request]: https://github.com/ttsim-dev/gettsim/pulls
[repository]: https://github.com/ttsim-dev/gettsim
[restructuredtext]: http://docutils.sourceforge.net/rst.html
[restructuredtextprimer]: http://www.sphinx-doc.org/en/stable/rest.html
[sphinx]: http://www.sphinx-doc.org/en/stable/
Expand Down
8 changes: 4 additions & 4 deletions docs/geps/gep-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,16 +186,16 @@ for that. Quoting from there:
The below refers to older versions of the GEP; it has been updated because
`GEP-6 <gep-6>` made much of the original content obsolete.

- GitHub PR: <https://github.com/iza-institute-of-labor-economics/gettsim/pull/60>
- GitHub PR: <https://github.com/ttsim-dev/gettsim/pull/60>
- Discussion on provisional acceptance:
<https://gettsim.zulipchat.com/#narrow/stream/309998-GEPs/topic/GEP.2001/near/189539859>
- GitHub PR for first update (character limits, time and unit identifiers, DAG
adjustments): <https://github.com/iza-institute-of-labor-economics/gettsim/pull/312>
adjustments): <https://github.com/ttsim-dev/gettsim/pull/312>
- GitHub PR for second update (concatenated column names, dealing with conflicting
objectives, names for columns vs parameters):
<https://github.com/iza-institute-of-labor-economics/gettsim/pull/342>
<https://github.com/ttsim-dev/gettsim/pull/342>
- GitHub PR for third update (changes because of `GEP-6 <gep-6>`):
<https://github.com/iza-institute-of-labor-economics/gettsim/pull/855>
<https://github.com/ttsim-dev/gettsim/pull/855>

## Copyright

Expand Down
2 changes: 1 addition & 1 deletion docs/geps/gep-02.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ taxes and transfers became too difficult.
- Zulip stream for
[GEP 2](https://gettsim.zulipchat.com/#narrow/stream/309998-GEPs/topic/GEP.2001/near/189539859).
- GitHub PR for update (changes because of `GEP-6 <gep-6>`):
<https://github.com/iza-institute-of-labor-economics/gettsim/pull/855>
<https://github.com/ttsim-dev/gettsim/pull/855>

## Copyright

Expand Down
6 changes: 3 additions & 3 deletions docs/geps/gep-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,16 +656,16 @@ the parameter (see the previous section), the following types are possible:

## Discussion

- <https://github.com/iza-institute-of-labor-economics/gettsim/pull/148>
- <https://github.com/ttsim-dev/gettsim/pull/148>
- <https://gettsim.zulipchat.com/#narrow/stream/309998-GEPs/topic/GEP.2003>
- GitHub PR for update (changes because of `GEP-6 <gep-6>`):
<https://github.com/iza-institute-of-labor-economics/gettsim/pull/855>
<https://github.com/ttsim-dev/gettsim/pull/855>

## Copyright

This document has been placed in the public domain.

## Appendix: json-schema for the yaml files

```{literalinclude} ../../src/ttsim/params-schema.json
```{literalinclude} ./params-schema.json
```
10 changes: 5 additions & 5 deletions docs/geps/gep-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ For example, we may need the number of adult household members. The following co
`household_characteristics.py` does this:

```python
from ttsim import AggType, agg_by_group_function
from gettsim.tt import AggType, agg_by_group_function


@agg_by_group_function(agg_type=AggType.SUM)
Expand Down Expand Up @@ -273,7 +273,7 @@ a node `kindergeld__betrag_m_bg` containing the Bedarfsgemeinschaft-level sum of
graph will be `kindergeld__betrag_m` and `bg_id`. This is the same as specifying:

```python
from ttsim import AggType, agg_by_group_function
from gettsim.tt import AggType, agg_by_group_function


@agg_by_group_function(agg_type=AggType.SUM)
Expand Down Expand Up @@ -305,7 +305,7 @@ values in `source` should be ascribed to. The key `agg` gives the aggregation me
For example, in the `kindergeld` namespace, we could have:

```python
from ttsim import AggType, agg_by_p_id_function
from gettsim.tt import AggType, agg_by_p_id_function


@agg_by_p_id_function(agg_type=AggType.SUM)
Expand Down Expand Up @@ -370,10 +370,10 @@ computational advantages.

## Discussion

- <https://github.com/iza-institute-of-labor-economics/gettsim/pull/178>
- <https://github.com/ttsim-dev/gettsim/pull/178>
- <https://gettsim.zulipchat.com/#narrow/stream/309998-GEPs/topic/GEP.2004>
- GitHub PR for update (changes because of `GEP-6 <gep-6>`):
<https://github.com/iza-institute-of-labor-economics/gettsim/pull/855>
<https://github.com/ttsim-dev/gettsim/pull/855>

## Copyright

Expand Down
11 changes: 5 additions & 6 deletions docs/geps/gep-05.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The snippet is taken from `sozialversicherung/rente/grundrente/grundrente.py`, w
contains the following code:

```python
from ttsim import policy_function, RoundingSpec, RoundingDirection
from gettsim.tt import policy_function, RoundingSpec, RoundingDirection


@policy_function(
Expand Down Expand Up @@ -101,13 +101,12 @@ parameter files) for the following reason:
## Discussion

- Zulip: <https://gettsim.zulipchat.com/#narrow/stream/309998-GEPs>
- PR: <https://github.com/iza-institute-of-labor-economics/gettsim/pull/324>
- PR Implementation:
<https://github.com/iza-institute-of-labor-economics/gettsim/pull/316>
- PR: <https://github.com/ttsim-dev/gettsim/pull/324>
- PR Implementation: <https://github.com/ttsim-dev/gettsim/pull/316>
- GitHub PR for update (changes because of `GEP-6 <gep-6>`):
<https://github.com/iza-institute-of-labor-economics/gettsim/pull/855>
<https://github.com/ttsim-dev/gettsim/pull/855>
- Github PR changing to a RoundingSpec class rather than parameters specified in the
yaml files: <https://github.com/iza-institute-of-labor-economics/gettsim/pull/854>
yaml files: <https://github.com/ttsim-dev/gettsim/pull/854>

## Copyright

Expand Down
24 changes: 12 additions & 12 deletions docs/geps/gep-06.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ in at least three directions:
sufficient context — in the examples above, those would be Arbeitslosengeld 2,
Erziehungsgeld, and Kinderzuschlag.
1. Handling functions that change over the years is not robust (examples in
[Issue 449](https://github.com/iza-institute-of-labor-economics/gettsim/issues/449)).
[Issue 449](https://github.com/ttsim-dev/gettsim/issues/449)).
1. Parameters files do not handle cases well when functions expect parameters in a
different form than the law specifies them (example:
[Issue 444](https://github.com/iza-institute-of-labor-economics/gettsim/issues/444)).
[Issue 444](https://github.com/ttsim-dev/gettsim/issues/444)).

These issues severely limit the development of GETTSIM. We have been spending far too
much time finding names that adhere to our self-imposed character limits. Functions with
Expand Down Expand Up @@ -264,17 +264,17 @@ There have been various discussions and preliminary implementations of some part
this GEP:

- Pull requests:
- [#787](https://github.com/iza-institute-of-labor-economics/gettsim/pulls/787) Model
classes for policy functions and policy environments
- [#720](https://github.com/iza-institute-of-labor-economics/gettsim/pulls/720)
Combined decorator for policy information,
- [#638](https://github.com/iza-institute-of-labor-economics/gettsim/pulls/638) Don’t
use functions in compute_taxes_and_transfers that are not active
- [#804](https://github.com/iza-institute-of-labor-economics/gettsim/pulls/804)
Namespaces for policy functions
- [#787](https://github.com/ttsim-dev/gettsim/pulls/787) Model classes for policy
functions and policy environments
- [#720](https://github.com/ttsim-dev/gettsim/pulls/720) Combined decorator for policy
information,
- [#638](https://github.com/ttsim-dev/gettsim/pulls/638) Don’t use functions in
compute_taxes_and_transfers that are not active
- [#804](https://github.com/ttsim-dev/gettsim/pulls/804) Namespaces for policy
functions
- Issues:
- [#781](https://github.com/iza-institute-of-labor-economics/gettsim/issues/781):
Summary of interface discussion from 2024 GETTSIM workshop
- [#781](https://github.com/ttsim-dev/gettsim/issues/781): Summary of interface
discussion from 2024 GETTSIM workshop
- [Zulip](https://gettsim.zulipchat.com/#narrow/channel/309998-GEPs/topic/GEP.2006)

## Copyright
Expand Down
5 changes: 2 additions & 3 deletions docs/geps/gep-07.md
Original file line number Diff line number Diff line change
Expand Up @@ -399,9 +399,8 @@ structure of GETTSIM described in [GEP 6](gep-06).

## Discussion

- **ENH: Interface, 2024 edition · Issue #781 · iza-institute-of-labor-economics/gettsim
\- Part 1**.
[https://github.com](https://github.com/iza-institute-of-labor-economics/gettsim/issues/781)
- **ENH: Interface, 2024 edition · Issue #781 · ttsim-dev/gettsim - Part 1**.
[https://github.com](https://github.com/ttsim-dev/gettsim/issues/781)

## Copyright

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"$comment": "If you change this file, always change it in both locations: 1. ttsim/src/ttsim/params-schema.json 2. gettsim/docs/geps/params-schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"patternProperties": {
Expand Down
16 changes: 7 additions & 9 deletions docs/gettsim_developer/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Contributions are always welcome. Everything ranging from small extensions of th
documentation to implementing new features is appreciated. Of course, the bigger the
change the more it is necessary to reach out to us in advance for an discussion. You can
start an discussion by
[posting an issue](https://github.com/iza-institute-of-labor-economics/gettsim/issues/new/choose)
which can be a bug report or a feature request or something else.
[posting an issue](https://github.com/ttsim-dev/gettsim/issues/new/choose) which can be
a bug report or a feature request or something else.

To get acquainted with the code base, you can also check out the
[documentation](https://gettsim.readthedocs.io/en/latest/) or our
[issue tracker](https://github.com/iza-institute-of-labor-economics/gettsim/issues) for
some immediate and clearly defined tasks.
[issue tracker](https://github.com/ttsim-dev/gettsim/issues) for some immediate and
clearly defined tasks.

To contribute to the project, adhere to the following process.

Expand All @@ -27,15 +27,13 @@ To contribute to the project, adhere to the following process.
Thus, you can clone the repository directly using

```shell-session
$ git clone https://github.com/iza-institute-of-labor-economics/gettsim
$ git clone https://github.com/ttsim-dev/gettsim
```

As a newcomer or infrequent contributor, you must first create a fork of GETTSIM which
is a copy of the repository into your account where you have unlimited access. Go to
the
[Github page of GETTSIM](https://github.com/iza-institute-of-labor-economics/gettsim)
and click on the fork button in the upper right corner. Then, clone your fork onto
your disk with
the [Github page of GETTSIM](https://github.com/ttsim-dev/gettsim) and click on the
fork button in the upper right corner. Then, clone your fork onto your disk with

```shell-session
$ git clone https://github.com/<user>/gettsim
Expand Down
9 changes: 4 additions & 5 deletions docs/gettsim_developer/how-to-maintain.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ The branching model for GETTSIM is very simple.
To release a new major or minor version of GETTSIM, do the following.

1. To start the release process for any new version, e.g., `0.2`, first
[create a new milestone](https://github.com/iza-institute-of-labor-economics/gettsim/milestones/new)
on Github. Set the name to the version number (format is `v[major].[minor]`, in this
[create a new milestone](https://github.com/ttsim-dev/gettsim/milestones/new) on
Github. Set the name to the version number (format is `v[major].[minor]`, in this
example: `v0.2`) to collect issues and PRs.

A consensus among developers determines the scope of the new release. Note that
Expand All @@ -48,9 +48,8 @@ To release a new major or minor version of GETTSIM, do the following.

1. Create a maintenance branch `[major].[minor]`, i.e., `0.2` in this example.

1. Go to the
[page for releases](https://github.com/iza-institute-of-labor-economics/gettsim/releases)
and draft a new release.
1. Go to the [page for releases](https://github.com/ttsim-dev/gettsim/releases) and
draft a new release.

- Set both a new tag and the release title to `vX.Y.Z`.
- Add the release notes. These should include the most important changes in a
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ accomplish specific tasks with GETTSIM.
caption: Links
hidden: true
---
gettsim on Github <https://github.com/iza-institute-of-labor-economics/gettsim>
gettsim on Github <https://github.com/ttsim-dev/gettsim>
```

```{toctree}
Expand Down
2 changes: 1 addition & 1 deletion outdated_docs/how-to-guides/calculating_elterngeld.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"\n",
"> **Note**: The Elterngeld implementation in GETTSIM does currently not consider income\n",
"> from self-employment or other sources. See\n",
"> [this](https://github.com/iza-institute-of-labor-economics/gettsim/issues/613) issue.\n",
"> [this](https://github.com/ttsim-dev/gettsim/issues/613) issue.\n",
"\n",
"So let's assume that income from dependent employment is the only source of income. If\n",
"you have only annual income data (and thus cannot compute gross income 12 months before\n",
Expand Down
Loading
Loading