Add setup.py so module can be installed. #85
Comments
|
This has been discussed and an early version was developed. I believe we decided to hold off on this for a while, but now I forget our reasoning. Leaving open for others to fill in details. |
|
I'm working on this in https://github.com/brainwane/HARK/tree/installability which I should have linked here much earlier - apologies! I should have it merged into |
|
We have some early developer releases available for |
|
Before merging the installability branch into master, can we fix the Models vs Demos issue? |
|
Thank you for that very good point, @mnwhite! The Models versus Demos issue @mnwhite mentioned is: in the @compumetrika asked when we were planning on merging the So here's how I propose to do this:
|
|
(Non-code note: I'm back stateside. Chris is doing the Bank of England and Venice presentations solo!) |
|
This sounds really great. It's not your job to do it, but as a note for other team members (i.e. Nathan): The next step after installability is merged in is to remove cstwMPC, cAndCwithStickyE, SolvingMicroDSOPs, and all of the Demos from HARK. When HARK is a package, those applications should not be installed. They will be provided separately on Econ-ARK as standalone archives and import the installed HARK. |
|
And because CDC keeps asking what we can call HARK 1.0: ^^^^ THAT! is HARK 1.0. A real package from which real research applications import their core functionality, extend it, and do their thing. The time is near, get hyped! |
In support of finding dependencies and transitive dependencies that make
packaging HARK more difficult, remove some of the import statements that
bring in dependencies that are not used in the code, as detected by
flake8:
git ls-files '*.py' | xargs flake8 --select=F401
In particular, some of the apparently-unused imports not removed are due
to usages flake8 can't detect, such as the fact that the
HARKutilities.warnings import has side effects, or the `exec()` use of
`copy.copy`.
Issue #85 Add setup.py so module can be installed
Make HARK packagable, so maintainers can make source distributions to distribute to PyPI (for pip installation) and conda packages to distribute to Anaconda.org (for conda installation). Add manifest, setup.py, setup.cfg, and requirements.txt file. Indicate that some papers are excluded. HARK and the Econ-ARK are under development, so a pre-release version identifier per PEP 440[1] is appropriate. [1] https://www.python.org/dev/peps/pep-0440/#pre-releases Issue #85 Add setup.py so module can be installed
As we move files around, it is helpful not to have extraneous, commented-out code. Issue #85 Add setup.py so module can be installed
Rename the parallel module, and refer to it by its new name in all the code in the repo that currently refers to it. Issue #85 Add setup.py so module can be installed
Rename the utilities module, and refer to it by its new name in all the code in the repo that currently refers to it. Issue #85 Add setup.py so module can be installed
Rename the simulations module, and refer to it by its new name in all the code in the repo that currently refers to it. Issue #85 Add setup.py so module can be installed
Rename the core module, and refer to it by its new name in all the code in the repo that currently refers to it. Issue #85 Add setup.py so module can be installed
Use the newly-packaged HARK instead of adding the path(s) of needed modules to the import path. This now requires HARK to be pip- or conda-installed. You can pip install from the root of the repository with `pip install .`. Issue #85 Add setup.py so module can be installed
Make HARK packagable, so maintainers can make source distributions to distribute to PyPI (for pip installation) and conda packages to distribute to Anaconda.org (for conda installation). Add manifest, setup.py, setup.cfg, and requirements.txt file. Indicate that some papers are excluded. HARK and the Econ-ARK are under development, so a pre-release version identifier per PEP 440[1] is appropriate. [1] https://www.python.org/dev/peps/pep-0440/#pre-releases Issue #85 Add setup.py so module can be installed
As we move files around, it is helpful not to have extraneous, commented-out code. Issue #85 Add setup.py so module can be installed
Rename the parallel module, and refer to it by its new name in all the code in the repo that currently refers to it. Issue #85 Add setup.py so module can be installed
Rename the utilities module, and refer to it by its new name in all the code in the repo that currently refers to it. Issue #85 Add setup.py so module can be installed
Rename the simulations module, and refer to it by its new name in all the code in the repo that currently refers to it. Issue #85 Add setup.py so module can be installed
Rename the core module, and refer to it by its new name in all the code in the repo that currently refers to it. Issue #85 Add setup.py so module can be installed
Use the newly-packaged HARK instead of adding the path(s) of needed modules to the import path. This now requires HARK to be pip- or conda-installed. You can pip install from the root of the repository with `pip install .`. Issue #85 Add setup.py so module can be installed
Use the newly-packaged HARK instead of adding the path(s) of needed modules to the import path. This now requires HARK to be pip- or conda-installed. You can pip install from the root of the repository with `pip install .`. Issue #85 Add setup.py so module can be installed
Use the newly-packaged HARK instead of adding the path(s) of needed modules to the import path. This now requires HARK to be pip- or conda-installed. You can pip install from the root of the repository with `pip install .`. Issue #85 Add setup.py so module can be installed
HARK.core contains the most important bits of HARK. Expose those bits under the "HARK" namespace, rather than requiring users to know about "HARK.core". This allows user to, for example, `from HARK import AgentType` rather than `from HARK.core import AgentType`. Issue #85 Add setup.py so module can be installed
No description provided.
The text was updated successfully, but these errors were encountered: