Metadata-Version: 2.4
Name: skillmodels
Version: 0.1.1
Summary: Estimators for skill formation models
Project-URL: Github, https://github.com/OpenSourceEconomics/skillmodels
Project-URL: Repository, https://github.com/OpenSourceEconomics/skillmodels
Project-URL: Tracker, https://github.com/OpenSourceEconomics/skillmodels/issues
Author-email: Janoś Gabler <janos.gabler@gmail.com>
Maintainer-email: Janoś Gabler <janos.gabler@gmail.com>, Hans-Martin von Gaudecker <hmgaudecker@uni-bonn.de>
License: MIT License
        
        Copyright (c) 2016- Janoś Gabler
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: Econometrics,Economics,Estimation,Skill formation,Statistics
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.15,>=3.14
Requires-Dist: beartype>=0.22
Requires-Dist: dags>=0.5.1
Requires-Dist: jax>=0.9
Requires-Dist: jupyter-book>=2
Requires-Dist: kaleido>=1.2
Requires-Dist: numpy>=2.4
Requires-Dist: optimagic>=0.5.3
Requires-Dist: pandas>=3
Requires-Dist: plotly>=6.6
Requires-Dist: pytask-parallel>=0.5.2
Requires-Dist: pytask>=0.5.8
Requires-Dist: scikit-learn>=1.5
Description-Content-Type: text/markdown

# skillmodels

## Introduction

Welcome to skillmodels, a Python implementation of estimators for skill formation
models. The econometrics of skill formation models is a very active field and several
estimators were proposed. None of them is implemented in standard econometrics packages.

## Installation

> **Warning:** To run skillmodels you need to install jax and jaxlib. At the time of
> writing, in most use cases, it is faster on a CPU than on a GPU, so it should be
> sufficient to install the CPU version, which is available on all platforms. In any
> case, for installation of jax and jaxlib, please consult the jax
> [docs](https://jax.readthedocs.io/en/latest/installation.html#supported-platforms).

Skillmodels can be installed via PyPI or via GitHub. To do so, type the following in a
terminal:

```console
$ pip install skillmodels
```

or, for the latest development version, type:

```console
$ pip install git+https://github.com/OpenSourceEconomics/skillmodels.git
```

## Documentation

[The documentation is hosted at readthedocs](https://skillmodels.readthedocs.io/en/latest/)

## Developing

We use [pixi](https://pixi.sh/latest/) for our local development environment. If you
want to work with or extend the skillmodels code base you can run the tests using

```console
$ git clone https://github.com/OpenSourceEconomics/skillmodels.git
$ pixi run tests
```

This will install the development environment and run the tests. You can run
[mypy](https://mypy-lang.org/) using

```console
$ pixi run mypy
```

Before committing, install the pre-commit hooks using

```console
$ pre-commit install
```

#### Documentation

You can build the documentation locally. After cloning the repository you can cd to the
docs directory and type:

```console
$ make html
```

## Citation

It took countless hours to write skillmodels. I make it available under a very
permissive license in the hope that it helps other people to do great research that
advances our knowledge about the formation of cognitive and noncognitive siklls. If you
find skillmodels helpful, please don't forget to cite it. Below you can find the bibtex
entry for a suggested citation. The suggested citation will be updated once the code
becomes part of a published paper.

```
@Unpublished{Gabler2024,
  Title                    = {A Python Library to Estimate Nonlinear Dynamic Latent Factor Models},
  Author                   = {Janos Gabler},
  Year                     = {2024},
  Url                      = {https://github.com/OpenSourceEconomics/skillmodels}
}
```

## Feedback

If you find skillmodels helpful for research or teaching, please let me know. If you
encounter any problems with the installation or while using skillmodels, please complain
or open an issue at [GitHub](https://github.com/OpenSourceEconomics/skillmodels)
