Holistic Energy Resource Optimization Network (HERON) is a modeling toolset and plugin for RAVEN to accelerate stochastic technoeconomic assessment of the economic viability of various grid-energy system configurations, especially with application to electrical grids and integrated energy systems (IES).
Apache License 2.0
24
stars
38
forks
source link
[DEFECT] Windows batch file does not generate full user manual #190
On Windows running the .bat file should generate the full user manual.
What did you see instead?
raven_libraries conda environment is not activated during execution, so if packages needed to generate the documentation are not in the user's base environment, the full user manual is not generated.
Do you have a suggested fix for the development team?
Activate the raven_libraries conda environment before running the script/generate_user_manual.py script.
Describe how to Reproduce
Steps to reproduce the behavior:
Be on Windows
Run make_docs.bat
Screenshots and Input Files
Please attach the input file(s) that generate this error. The simpler the input, the faster we can find the issue.
Platform (please complete the following information):
OS: [e.g. iOS]
Version: [e.g. 22]
Dependencies Installation: [CONDA or PIP]
For Change Control Board: Issue Review
This review should occur before any development is performed as a response to this issue.
[ ] 1. Is it tagged with a type: defect or task?
[ ] 2. Is it tagged with a priority: critical, normal or minor?
[ ] 3. If it will impact requirements or requirements tests, is it tagged with requirements?
[ ] 4. If it is a defect, can it cause wrong results for users? If so an email needs to be sent to the users.
[ ] 5. Is a rationale provided? (Such as explaining why the improvement is needed or why current code is wrong.)
For Change Control Board: Issue Closure
This review should occur when the issue is imminently going to be closed.
[x] 1. If the issue is a defect, is the defect fixed?
[x] 2. If the issue is a defect, is the defect tested for in the regression test system? (If not explain why not.)
[x] 3. If the issue can impact users, has an email to the users group been written (the email should specify if the defect impacts stable or master)?
[x] 4. If the issue is a defect, does it impact the latest release branch? If yes, is there any issue tagged with release (create if needed)?
[x] 5. If the issue is being closed without a pull request, has an explanation of why it is being closed been provided?
Defect Description
Describe the defect
What did you expect to see happen?
On Windows running the .bat file should generate the full user manual.
What did you see instead?
raven_libraries conda environment is not activated during execution, so if packages needed to generate the documentation are not in the user's base environment, the full user manual is not generated.
Do you have a suggested fix for the development team?
Activate the raven_libraries conda environment before running the script/generate_user_manual.py script.
Describe how to Reproduce Steps to reproduce the behavior:
Screenshots and Input Files Please attach the input file(s) that generate this error. The simpler the input, the faster we can find the issue.
Platform (please complete the following information):
For Change Control Board: Issue Review
This review should occur before any development is performed as a response to this issue.
For Change Control Board: Issue Closure
This review should occur when the issue is imminently going to be closed.