diff --git a/README.md b/README.md index acab210..d7359bf 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,61 @@ -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 ------------- - -The package can be installed via conda. To do so, type the following in a terminal: - - -conda config --add channels conda-forge -conda config --add channels janosg -conda install skillmodels - - -Documentation -------------- - -[The documentation is hosted at readthedocs](https://skillmodels.readthedocs.io/en/latest/) - -Alternatively, you can build it locally. After cloning the repository you can cd to the docs directory and type: - -make html - - - -Building the package with conda-build -------------------------------------- - -If you want to make changes to the source code of skillmodels or build the package on your machine for any other reason, you can do so with conda-build. - -* clone the repository and make your changes -* Install conda-build 2.0 or higher (earlier versions won't work!) -* Adjust the version number in setup.py and meta.yaml. -* Open a shell in the directory that contains skillmodels (i.e. one level higher than your git repository) -* type: conda build skillmodels - -For more information see the [conda documentation](http://conda.pydata.org/docs/building/build.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{Gabler2018, - Title = {A Python Library to Estimate Nonlinear Dynamic Latent Factor Models}, - Author = {Janos Gabler}, - Year = {2018}, - Url = {https://github.com/janosg/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/janosg/skillmodels) +# 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 + +The package can be installed via conda. To do so, type the following in a terminal: + +conda config --add channels conda-forge conda install skillmodels + +## Documentation + +[The documentation is hosted at readthedocs](https://skillmodels.readthedocs.io/en/latest/) + +Alternatively, you can build it locally. After cloning the repository you can cd to the +docs directory and type: + +make html + +## Building the package with conda-build + +If you want to make changes to the source code of skillmodels or build the package on +your machine for any other reason, you can do so with conda-build. + +- clone the repository and make your changes +- Install conda-build 2.0 or higher (earlier versions won't work!) +- Adjust the version number in setup.py and meta.yaml. +- Open a shell in the directory that contains skillmodels (i.e. one level higher than + your git repository) +- type: conda build skillmodels + +For more information see the +[conda documentation](http://conda.pydata.org/docs/building/build.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{Gabler2018, + Title = {A Python Library to Estimate Nonlinear Dynamic Latent Factor Models}, + Author = {Janos Gabler}, + Year = {2018}, + 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) diff --git a/docs/source/getting_started/tutorial.ipynb b/docs/source/getting_started/tutorial.ipynb index 4066a04..5611064 100644 --- a/docs/source/getting_started/tutorial.ipynb +++ b/docs/source/getting_started/tutorial.ipynb @@ -15,6 +15,7 @@ "source": [ "from time import time\n", "\n", + "import optimagic as om\n", "import pandas as pd\n", "import yaml\n", "\n", diff --git a/docs/source/index.rst b/docs/source/index.rst index 7ee1104..37219c7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -126,7 +126,7 @@ skillmodels, please complain or open an issue at `GitHub`_. https://tinyurl.com/yyuq2sa4 .. _GitHub: - https://github.com/janosg/skillmodels + https://github.com/OpenSourceEconomics/skillmodels .. _Econometrica 2010: diff --git a/docs/source/rtd_environment.yml b/docs/source/rtd_environment.yml index ba8ebe5..66fd046 100644 --- a/docs/source/rtd_environment.yml +++ b/docs/source/rtd_environment.yml @@ -2,9 +2,8 @@ name: skillmodels_rtd channels: - conda-forge - - janosg dependencies: - - python=3.7 + - python=3.12 - skillmodels - sphinxcontrib-bibtex - pydata-sphinx-theme>=0.3 diff --git a/pyproject.toml b/pyproject.toml index df5a0a3..d23521d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -47,9 +47,9 @@ content-type = "text/markdown" text = "MIT" [project.urls] -Repository = "https://github.com/janosg/skillmodels" -Github = "https://github.com/janosg/skillmodels" -Tracker = "https://github.com/janosg/skillmodels/issues" +Repository = "https://github.com/OpenSourceEconomics/skillmodels" +Github = "https://github.com/OpenSourceEconomics/skillmodels" +Tracker = "https://github.com/OpenSourceEconomics/skillmodels/issues" # ======================================================================================