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

Update installation instructions #132

Open
wants to merge 64 commits into
base: develop
Choose a base branch
from

Conversation

paulf81
Copy link
Collaborator

@paulf81 paulf81 commented Dec 5, 2024

This small PR updates the installation codes and instructions to make a few improvements to current practice. Main current changes are:

Changes

  • Changes SEAS reference from main to v1
  • Removes unnecessary pysam installation instruction since this is now a dependency
  • Cleans up installation instructions

@paulf81 paulf81 added the documentation Improvements or additions to documentation label Dec 5, 2024
@paulf81 paulf81 self-assigned this Dec 5, 2024
@paulf81 paulf81 marked this pull request as ready for review December 5, 2024 21:58

To run locally using a standin for AMR-Wind, launch 3 separate
To run locally without the included runscript using a standin for AMR-Wind, launch 3 separate
terminals. In each, `conda activate` your hercules environment (`conda
activate hercules`).

Copy link
Collaborator

@misi9170 misi9170 Dec 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't actually comment on the lines below this, because this PR doesn't change them, but they seem to assume the user has already declared a HELICS_PORT variable?

Also, hercules_runscript_dummy_amr.py doesn't exist anymore (should be some sort of florisstandin runscript)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'm not positive about this whole section. In the same way as the runscript in each folder might be a little different, the manual version might also be a little different and the best approach would be just to enter the lines appearing in the runscript as they appear. Possibly in 3 terminals, or using the & to unblock, maybe just shorten this section to something more like "to be sure, it's possible to enter the commands in the runscript directly..."?

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 it makes sense to encourage people to use the run_script.sh . So, perhaps those instructions should come first. But then, maybe it is worth taking the example of one of the run_script.sh , and talking through what each line is doing (and explain that it is possible to run this from three separate terminals, if that's what the user would prefer to do)?

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

Successfully merging this pull request may close these issues.

4 participants