-
-
Notifications
You must be signed in to change notification settings - Fork 198
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes to quick-start guide #1366
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few suggestions aimed at simplifying the quick-start guide.
A
Documentation/guides/quick_start.md
Outdated
|
||
To install `virtualenv`, then to create an environment named `econ-ark`, and finally to activate that environment: | ||
To create a new virtual environment, enter this in your command line: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we ought recommend conda
, perhaps replace the rest of this sub-section with the following?
To create a new environment, follow the steps below in your command line:
1. We first set up a Conda 'environment' for HARK.
This is a way of isolating the installation of HARK so that it does not interfere
with any other Python scripts or modules on your computer.
To do so, at a command line type:
```console
$ conda create -n econ-ark "python=3.10"
```
2. Activate the environment:
```console
$ conda activate econ-ark
```
3. Install HARK into the environment:
```console
(econ-ark) $ conda install econ-ark
```
I'd also consider remove the line about installing a non-default release, I'm unsure if it fits in the quick-start guide.
Documentation/guides/quick_start.md
Outdated
@@ -103,44 +90,25 @@ The most broadly applicable advice is to go to [Econ-ARK](https://econ-ark.org) | |||
|
|||
## Making changes to HARK |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Arguably this doesn't belong in the quick-start guide -- perhaps just redirect to the contributing guide?
Documentation/guides/quick_start.md
Outdated
|
||
- If you don't want to clone HARK, but just to download it, go to [the HARK repository on GitHub](https://github.com/econ-ark/HARK). In the upper righthand corner is a button that says "clone or download". Click the "Download Zip" option and then unzip the contents into your chosen directory. | ||
### Demonstrations on using HARK |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sub-section should go within "Learning HARK" below
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@sidd3888 can you look at @AA-Turner's comments and make appropriate changes so we can merge this PR? |
Have made changes according to @AA-Turner's suggestions. The only thing in which I differ was recommending the installation using |
Made substantial changes to the structure of the quick start guide.
pip
whether using an Anaconda or Miniconda distribution or the standard PyPI installI have removed the part on installing HARK using
conda-forge
, as I think it can be relegated to the installation guide alone. The quick start should serve its primary purpose by providing a single best way to get started.