Skip to content

Commit

Permalink
Merge pull request #356 from econ-ark/llorracc-patch-1
Browse files Browse the repository at this point in the history
Streamline installation instructions in README
  • Loading branch information
llorracc authored Jul 18, 2019
2 parents a2d353d + e737fdc commit 832cb10
Showing 1 changed file with 12 additions and 21 deletions.
33 changes: 12 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Table of Contents:
* [1. Introduction](#i-introduction)
* [2. Quick start guide](#ii-quick-start-guide)
* [Installing](#Installing-HARK)
* [Installing Anaconda](#Using-HARK-with-Anaconda)
* [Learning HARK](#Learning-HARK)
* [3. List of files in repository](#iii-list-of-files-in-repository)
* [4. Warnings and disclaimers](#iv-warnings-and-disclaimers)
Expand All @@ -18,33 +19,22 @@ Table of Contents:

## I. INTRODUCTION

Welcome to HARK! This document will tell you how to get HARK up and
This document will tell you how to get HARK up and
running on your machine, how to get started using it, and give you an
overview of the main elements of the toolkit.

If you have any comments on the code or documentation, or (even better) if you want to
contribute new content to HARK, we'd love to hear from you!
Our email addresses are:

* Chris Carroll: [email protected]
* Matthew White: [email protected]

GitHub repository: https://github.com/econ-ark/HARK

Online documentation: https://econ-ark.github.io/HARK

User guide: [Documentation/HARKmanual.pdf](Documentation/HARKmanual.pdf) (in the [HARK repository](https://github.com/econ-ark/HARK))

Demonstrations of HARK functionality: [DemARK](https://github.com/econ-ark/DemARK/)

Replications and Explorations Made using the ARK : [REMARK](https://github.com/econ-ark/REMARK/)

Other useful resources are:
* Documentation: [Sphinx/ReadTheDocs](https://econ-ark.github.io/HARK)
* User guide: [Documentation/HARKmanual.pdf](Documentation/HARKmanual.pdf)
* In the [HARK repository](https://github.com/econ-ark/HARK)
* Demonstrations of HARK functionality: [DemARK](https://github.com/econ-ark/DemARK/)
* Replications and Explorations Made using the ARK : [REMARK](https://github.com/econ-ark/REMARK/)

## II. QUICK START GUIDE

### Installing HARK
HARK is an open source project written in Python. It's compatible with both Python
2 and 3, and with the Anaconda distributions of python 2 and 3. But we recommend

HARK is an open source project that is compatible with both python 2 and 3. But we recommend
using python 3; eventually support for python 2 will end.

#### Installing HARK with pip
Expand All @@ -67,14 +57,15 @@ source activate econ-ark
----
#### Using HARK with Anaconda

Installing HARK with pip does not give you full access to HARK's many graphical capabilities. One way to access these capabilities is by using [Anaconda](https://anaconda.com/why-anaconda), which is a distribution of python along with many packages that are frequently used in scientific computing..
If you intend ever to use the toolkit for anything other than running the precooked material we have provided, you should probably install [Anaconda](https://anaconda.com/why-anaconda), which will install python along with many packages that are frequently used in scientific computing.

1. Download Anaconda for your operating system and follow the installation instructions [at Anaconda.com](https://www.anaconda.com/distribution/#download-section).

1. Anaconda includes its own virtual environment system called `conda` which stores environments in a preset location (so you don't have to choose). So in order to create and activate an econ-ark virtual environment:
```
conda create -n econ-ark anaconda
conda activate econ-ark
conda install -c conda-forge econ-ark
```
1. Open Spyder, an interactive development environment (IDE) for Python (specifically, iPython). You may be able to do this through Anaconda's graphical interface, or you can do so from the command line/prompt. To do so, simply open a command line/prompt and type `spyder`.

Expand Down

0 comments on commit 832cb10

Please sign in to comment.