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

Improve Quick Start instructions #6

Open
3 tasks
erickb opened this issue Oct 3, 2023 · 2 comments
Open
3 tasks

Improve Quick Start instructions #6

erickb opened this issue Oct 3, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@erickb
Copy link
Collaborator

erickb commented Oct 3, 2023

  • Add note that it is best to check "Add Julia to PATH" when installing Julia
  • Expand upon "open Julia in that folder", providing multiple options
  • Add privacy statement and report .zip download is safe to MS
@erickb erickb added the documentation Improvements or additions to documentation label Oct 3, 2023
@erickb erickb self-assigned this Oct 3, 2023
@erickb
Copy link
Collaborator Author

erickb commented Nov 8, 2023

From a user: "I have tried to start running AMES following the Quick Start instruction.
Unfortunately, I did not understand the fourth step, "4. Start Julia in that folder and run the demo model."
I would like to have more explanation from you"

@erickb
Copy link
Collaborator Author

erickb commented Nov 8, 2023

Sample instructions:

  1. Start Julia (for example, by clicking on the Desktop icon).
  2. Change the directory to where you have unzipped the sample files using Julia’s “cd()” (change directory) function. For example:
julia> cd(raw"C:\PATH TO FOLDER\AMES")

Note that I used a “raw” string, raw"…". If you don’t do that, then Julia has trouble with the backslashes.

  1. Now you are in that folder. You can check by using Julia’s function “pwd()” (print working directory) function.

Now you have opened Julia in the folder where you unzipped the files and you can follow the instructions.

Here is another way:

  1. Open a Windows command prompt.
  2. Use Windows’ cd command: C:\> cd C:\PATH TO FOLDER\AMES
  3. Start Julia: C:\> julia

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant