QuantEcon.py

QuantEcon.py: A community based Python library for quantitative economics - Published in JOSS (2024)

https://github.com/quantecon/quantecon.py

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README and JOSS metadata
  • Academic publication links
  • Committers with academic emails
    10 of 49 committers (20.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

pde neuroimaging optimisation cryptocurrencies meshes unconstrained-optimization unconstrained-optimisation optim simulations transportation

Scientific Fields

Mathematics Computer Science - 88% confidence
Economics Social Sciences - 85% confidence
Last synced: 4 months ago · JSON representation ·

Repository

A community based Python library for quantitative economics

Basic Info
Statistics
  • Stars: 2,194
  • Watchers: 151
  • Forks: 2,276
  • Open Issues: 60
  • Releases: 19
Created almost 13 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog License Citation

README.md

QuantEcon.py

A high performance, open source Python code library for economics

python from quantecon.markov import DiscreteDP aiyagari_ddp = DiscreteDP(R, Q, beta) results = aiyagari_ddp.solve(method='policy_iteration')

Build Status Coverage Status Documentation (stable) Documentation (latest) PyPI Version PyPI - Python Version

Installation

Before installing quantecon we recommend you install the Anaconda Python distribution, which includes a full suite of scientific python tools.

Next you can install quantecon by opening a terminal prompt and typing

pip install quantecon

or using conda-forge by typing

conda install -c conda-forge quantecon

Usage

Once quantecon has been installed you should be able to import it as follows:

python import quantecon as qe

You can check the version by running

python print(qe.__version__)

If your version is below what’s available on PyPI then it is time to upgrade. This can be done by running

pip install --upgrade quantecon

Examples and Sample Code

Many examples of QuantEcon.py in action can be found at Quantitative Economics. See also the

QuantEcon.py is supported financially by the Alfred P. Sloan Foundation and is part of the QuantEcon organization.

Downloading the quantecon Repository

An alternative is to download the sourcecode of the quantecon package and install it manually from the github repository. For example, if you have git installed type

git clone https://github.com/QuantEcon/QuantEcon.py

Once you have downloaded the source files then the package can be installed by running

pip install flit
flit install

(To learn the basics about setting up Git see this link.)

Citation

QuantEcon.py is MIT licensed, so you are free to use it without any charge and restriction. If it is convenient for you, please cite QuantEcon.py when using it in your work and also consider contributing all your changes back, so that we can incorporate it.

A BibTeX entry for LaTeX users is

bibtex @article{10.21105/joss.05585, author = {Batista, Quentin and Coleman, Chase and Furusawa, Yuya and Hu, Shu and Lunagariya, Smit and Lyon, Spencer and McKay, Matthew and Oyama, Daisuke and Sargent, Thomas J. and Shi, Zejin and Stachurski, John and Winant, Pablo and Watkins, Natasha and Yang, Ziyue and Zhang, Hengcheng}, doi = {10.5281/zenodo.10345102}, title = {QuantEcon.py: A community based Python library for quantitative economics}, year = {2024}, journal = {Journal of Open Source Software}, volume = {9}, number = {93}, pages = {5585} }

Star History

Star History Chart

Owner

  • Name: QuantEcon
  • Login: QuantEcon
  • Kind: organization
  • Email: contact@quantecon.org

Open source code for quantitative economic modeling

JOSS Publication

QuantEcon.py: A community based Python library for quantitative economics
Published
January 06, 2024
Volume 9, Issue 93, Page 5585
Authors
Quentin Batista
Massachusetts Institute of Technology
Chase Coleman
New York University
Yuya Furusawa
Crop.inc
Shu Hu
The Australian National University
Smit Lunagariya
Indian Institute of Technology (BHU), Varanasi
Spencer Lyon
New York University
Matthew McKay
The Australian National University
Daisuke Oyama
University of Tokyo
Thomas J. Sargent
New York University
Zejin Shi
The University of Arizona
John Stachurski
The Australian National University
Pablo Winant
ESCP Business School and Ecole Polytechnique
Natasha Watkins
The Australian National University
Ziyue Yang
The Australian National University
Hengcheng Zhang
The Australian National University
Editor
Sebastian Benthall ORCID
Tags
Economics

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Batista
  given-names: Quentin
- family-names: Coleman
  given-names: Chase
- family-names: Furusawa
  given-names: Yuya
- family-names: Hu
  given-names: Shu
- family-names: Lunagariya
  given-names: Smit
- family-names: Lyon
  given-names: Spencer
- family-names: McKay
  given-names: Matthew
- family-names: Oyama
  given-names: Daisuke
- family-names: Sargent
  given-names: Thomas J.
- family-names: Shi
  given-names: Zejin
- family-names: Stachurski
  given-names: John
- family-names: Winant
  given-names: Pablo
- family-names: Watkins
  given-names: Natasha
- family-names: Yang
  given-names: Ziyue
- family-names: Zhang
  given-names: Hengcheng
doi: 10.5281/zenodo.10345102
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Batista
    given-names: Quentin
  - family-names: Coleman
    given-names: Chase
  - family-names: Furusawa
    given-names: Yuya
  - family-names: Hu
    given-names: Shu
  - family-names: Lunagariya
    given-names: Smit
  - family-names: Lyon
    given-names: Spencer
  - family-names: McKay
    given-names: Matthew
  - family-names: Oyama
    given-names: Daisuke
  - family-names: Sargent
    given-names: Thomas J.
  - family-names: Shi
    given-names: Zejin
  - family-names: Stachurski
    given-names: John
  - family-names: Winant
    given-names: Pablo
  - family-names: Watkins
    given-names: Natasha
  - family-names: Yang
    given-names: Ziyue
  - family-names: Zhang
    given-names: Hengcheng
  date-published: 2024-01-06
  doi: 10.21105/joss.05585
  issn: 2475-9066
  issue: 93
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5585
  title: "QuantEcon.py: A community based Python library for
    quantitative economics"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05585"
  volume: 9
title: "QuantEcon.py: A community based Python library for quantitative
  economics"

GitHub Events

Total
  • Create event: 41
  • Release event: 5
  • Issues event: 25
  • Watch event: 201
  • Delete event: 37
  • Issue comment event: 152
  • Push event: 118
  • Pull request review comment event: 37
  • Pull request review event: 59
  • Pull request event: 84
  • Fork event: 65
Last Year
  • Create event: 41
  • Release event: 5
  • Issues event: 25
  • Watch event: 201
  • Delete event: 37
  • Issue comment event: 152
  • Push event: 118
  • Pull request review comment event: 37
  • Pull request review event: 59
  • Pull request event: 84
  • Fork event: 65

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 1,443
  • Total Committers: 49
  • Avg Commits per committer: 29.449
  • Development Distribution Score (DDS): 0.765
Past Year
  • Commits: 43
  • Committers: 7
  • Avg Commits per committer: 6.143
  • Development Distribution Score (DDS): 0.302
Top Committers
Name Email Commits
Daisuke Oyama o****a@e****p 339
Matthew McKay m****y@g****m 310
David R. Pugh d****h@g****m 214
John Stachurski j****i@g****m 188
chase c****8@g****m 89
Spencer Lyon s****2@g****m 58
Smit-create s****8@i****n 46
rht r****t@p****m 38
QBatista q****a@m****a 21
Zejin Shi s****4@g****m 19
Natasha t****s@g****m 18
Duncan Hobbs d****2@g****m 10
Thomas Sargent t****3@n****u 9
Yuya Furusawa f****8@g****m 7
Kyohei Okumura k****a@g****m 6
Supavit Dumrongprechachan s****n 6
Zejin Shi 6
Spencer Lyon s****n@G****l 5
Pablo Winant p****t@g****m 5
kp992 1****2 5
Matthew McKay m****y@a****u 4
Yuya Furusawa y****a@Y****l 3
Taha K 1****a 3
cd c****o@u****u 3
Shunsuke-Hori h****8@g****m 2
Zé Vinícius j****a@g****m 2
lbui01 l****1@g****m 2
mathuranand a****r@i****m 2
unknown t****i@j****p 2
Spencer Lyon s****n@S****l 2
and 19 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 71
  • Total pull requests: 164
  • Average time to close issues: about 1 year
  • Average time to close pull requests: about 1 month
  • Total issue authors: 21
  • Total pull request authors: 21
  • Average comments per issue: 2.62
  • Average comments per pull request: 3.77
  • Merged pull requests: 136
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 10
  • Pull requests: 76
  • Average time to close issues: 8 days
  • Average time to close pull requests: 6 days
  • Issue authors: 3
  • Pull request authors: 7
  • Average comments per issue: 0.5
  • Average comments per pull request: 2.8
  • Merged pull requests: 63
  • Bot issues: 0
  • Bot pull requests: 3
Top Authors
Issue Authors
  • oyamad (20)
  • mmcky (14)
  • jstac (9)
  • Smit-create (7)
  • rht (3)
  • QBatista (2)
  • sglyon (2)
  • gabriellequeran (1)
  • longye-tian (1)
  • janosg (1)
  • shizejin (1)
  • intuser (1)
  • sebgraves (1)
  • HengchengZhang (1)
  • zlqs1985 (1)
Pull Request Authors
  • oyamad (77)
  • mmcky (26)
  • Smit-create (18)
  • kp992 (12)
  • Copilot (6)
  • jstac (3)
  • dependabot[bot] (3)
  • hsalberti (2)
  • Armd04 (2)
  • rht (2)
  • GautamsGitHub (2)
  • thynash (2)
  • sglyon (1)
  • Shunsuke-Hori (1)
  • faze-geek (1)
Top Labels
Issue Labels
discuss (16) maintenance (13) documentation (10) enhancement (6) help wanted (5) bug (5) breaking (4) tests (4) wishlist (3) refactor (2) CI (2) upstream (2) question (1) beginner (1)
Pull Request Labels
ready (82) maintenance (41) CI (20) refactor (19) documentation (16) enhancement (15) tests (14) bug (12) in-work (4) performance (3) do-not-merge (3) dependencies (3) high priority (2) breaking (1) github_actions (1)

Packages

  • Total packages: 4
  • Total downloads:
    • pypi 35,536 last-month
  • Total docker downloads: 984
  • Total dependent packages: 9
    (may contain duplicates)
  • Total dependent repositories: 100
    (may contain duplicates)
  • Total versions: 69
  • Total maintainers: 2
pypi.org: quantecon

Import the main names to top level.

  • Versions: 47
  • Dependent Packages: 5
  • Dependent Repositories: 84
  • Downloads: 35,507 Last month
  • Docker Downloads: 984
Rankings
Forks count: 0.3%
Dependent repos count: 1.6%
Stargazers count: 1.7%
Docker downloads count: 1.7%
Average: 1.7%
Downloads: 1.9%
Dependent packages count: 3.2%
Maintainers (2)
Funding
  • https://quantecon.org
Last synced: 4 months ago
conda-forge.org: quantecon

**QuantEcon** is an organization run by economists for economists with the aim of coordinating distributed development of high quality open source code for all forms of quantitative economic modelling. The project website is located at [http://quantecon.org/](http://quantecon.org/). This website provides more information with regards to the **quantecon** library, documentation, in addition to some resources in regards to how you can use and/or contribute to the package. The [repository](https://github.com/QuantEcon/QuantEcon.py>) includes the *conda-forge* build recipe for the *quantecon* python package. **Note:** There is also a Julia version available for Julia users [QuantEcon.jl](https://github.com/QuantEcon/QuantEcon.jl)

  • Versions: 15
  • Dependent Packages: 4
  • Dependent Repositories: 8
Rankings
Forks count: 2.5%
Average: 9.2%
Stargazers count: 9.9%
Dependent repos count: 12.1%
Dependent packages count: 12.5%
Last synced: 4 months ago
pypi.org: quantecon_wasm

Import the main names to top level.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 29 Last month
Rankings
Forks count: 0.6%
Stargazers count: 2.4%
Dependent packages count: 9.7%
Average: 16.9%
Dependent repos count: 54.8%
Maintainers (1)
Funding
  • https://quantecon.org
Last synced: 4 months ago
anaconda.org: quantecon

**QuantEcon** is an organization run by economists for economists with the aim of coordinating distributed development of high quality open source code for all forms of quantitative economic modelling. The project website is located at [http://quantecon.org/](http://quantecon.org/). This website provides more information with regards to the **quantecon** library, documentation, in addition to some resources in regards to how you can use and/or contribute to the package. The [repository](https://github.com/QuantEcon/QuantEcon.py>) includes the *conda-forge* build recipe for the *quantecon* python package. **Note:** There is also a Julia version available for Julia users [QuantEcon.jl](https://github.com/QuantEcon/QuantEcon.jl)

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 8
Rankings
Forks count: 7.0%
Stargazers count: 18.8%
Average: 26.5%
Dependent repos count: 39.4%
Dependent packages count: 41.0%
Last synced: 4 months ago

Dependencies

docs/rtd-requirements.txt pypi
  • ipython *
  • matplotlib *
  • numba >=0.38
  • numpy >=1.2
  • numpydoc *
  • requests *
  • scipy >=1.0
  • sphinx *
  • sympy *
.github/workflows/ci.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • conda-incubator/setup-miniconda v2 composite
  • coverallsapp/github-action master composite
pyproject.toml pypi
  • numba >=0.49.0
  • numpy >=1.17.0
  • requests *
  • scipy >=1.5.0
  • sympy *
environment.yml pypi