Skip to content
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

Merged
merged 7 commits into from
Apr 18, 2024
Merged

Conversation

sidd3888
Copy link
Collaborator

Made substantial changes to the structure of the quick start guide.

  • Emphasised installation using pip whether using an Anaconda or Miniconda distribution or the standard PyPI install
  • Shortened the guide to remove unnecessary elements for a beginner, including the section on testing out HARK using Spyder
  • Removed redundancies such as repeated instructions on creating virtual environments
  • Streamlined most of the content to make it more beginner friendly

I 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.

Copy link
Collaborator

@AA-Turner AA-Turner left a 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 Show resolved Hide resolved
Documentation/guides/quick_start.md Show resolved Hide resolved

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:
Copy link
Collaborator

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.

@@ -103,44 +90,25 @@ The most broadly applicable advice is to go to [Econ-ARK](https://econ-ark.org)

## Making changes to HARK
Copy link
Collaborator

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?


- 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
Copy link
Collaborator

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

alanlujan91 and others added 2 commits March 1, 2024 19:24
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@alanlujan91
Copy link
Member

@sidd3888 can you look at @AA-Turner's comments and make appropriate changes so we can merge this PR?

@sidd3888
Copy link
Collaborator Author

Have made changes according to @AA-Turner's suggestions. The only thing in which I differ was recommending the installation using conda-forge, as it seemed to be more prone to conflicts than the pip version, particularly because it installs older versions of everything else. That said, I have decluttered all other parts of the guide. If this sounds good, then lets go ahead with it. If we must insist on conda-forge, then I can make that change too.

@sidd3888 sidd3888 added the Ready-To-Merge Has been reviewed and when branch is updated and checks pass it should be merged label Apr 17, 2024
@alanlujan91 alanlujan91 merged commit c6508c2 into econ-ark:master Apr 18, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ready-To-Merge Has been reviewed and when branch is updated and checks pass it should be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants