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

Installation suggestions #22

Closed
Plavit opened this issue Aug 10, 2023 · 5 comments · Fixed by #97
Closed

Installation suggestions #22

Plavit opened this issue Aug 10, 2023 · 5 comments · Fixed by #97
Assignees
Labels
enhancement New feature or request

Comments

@Plavit
Copy link

Plavit commented Aug 10, 2023

Background

I was installing GridLAB-D in the past few days for a research project and it proved unnecessarily complex, I propose a few changes to Readme that will solve this issue.

Proposed solution

Three changes proposed to README.md for better clarity:

  1. Remove the Contributions section, as https://source.gridlabd.us/blob/master/CONTRIBUTING.md does not exist.

  2. Add the following to the Windows WSL section:
    GridLAB-D supports several WSL distributions, including the latest Ubuntu versions. See the setup folder for currently supported distributions.

  3. Add the following to the Windows WSL section below the validation code ./build.sh --system --validate :
    The validation may take some time and it need not complete completely successfully for GridLAB-D to be used. The final report may look something like this:

Validation report:
747 models tested
1 unexpected errors
746 tests succeeded
>99% success rate
Total validation elapsed time: 281.9 seconds
See '/home/username/gridlabd/validate.txt' for details
ERROR [build.sh]: unable to verify install 

Alternatives

Feel free to amend my proposed wording

Additional context

Not needed

@Plavit Plavit added the enhancement New feature or request label Aug 10, 2023
@dchassin dchassin changed the title (Provide a one-line synopsis of your enhancement request) Installation suggestions Aug 11, 2023
@dchassin
Copy link
Member

@Plavit, have you considered using the pre-built images instead of building it yourself?

@Plavit
Copy link
Author

Plavit commented Aug 11, 2023

I built it fine in the end, however it's possible that we might need to make some source tweaks in our research project so I needed to build from source along with my colleagues.

I am therefore humbly proposing minor edits in the readme that, in my opinion, would help others that will use the WSL approach in the future.

I do realise of course it is up to your consideration whether to include the suggestions, however I do believe that it would be a useful edit for those that will consider working with the tool. 🙏

@dchassin
Copy link
Member

@Plavit, thanks for the suggestions.

@dchassin dchassin transferred this issue from arras-energy/gridlabd-old Sep 27, 2023
@dchassin dchassin mentioned this issue Sep 29, 2023
4 tasks
@dchassin dchassin linked a pull request Sep 29, 2023 that will close this issue
4 tasks
@dchassin
Copy link
Member

@Plavit, do you plan to submit your source code changes at some point? If so, please note that we had to rebuild the original arras-energy/gridlabd repo from scratch due to problems with old DCOs. The original repo is renamed gridlabd-old and the new one is now called gridlabd. Consequently, you may need to fork the new one to get updates and submit contributions.

@Plavit
Copy link
Author

Plavit commented Sep 29, 2023

Okay, we'll look into it, thanks for highlighting!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants