-
Notifications
You must be signed in to change notification settings - Fork 24
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
#3273 how to execute dynawo on windows is not properly described in the readme #3378
base: master
Are you sure you want to change the base?
#3273 how to execute dynawo on windows is not properly described in the readme #3378
Conversation
Signed-off-by: Dimitri Baron <dimitri.baron@rte-france.com>
Signed-off-by: Dimitri Baron <dimitri.baron@rte-france.com>
2cdf3fa
to
86e600f
Compare
README.md
Outdated
``` | ||
**Tip** If you have already OpenModelica installed in another Dynawo workspace, it is possible to set the following environment variables to use the existing OpenModelica installation and avoid recompiling OpenModelica again : | ||
``` batch | ||
> set OPENMODELICA_INSTALL=PATH_TO_OPENMODELICA_INSTALL |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also need a section in which we describe how to launch a simulation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to complete this https://github.com/dynawo/dynawo?tab=readme-ov-file#windows-3 ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so I took a second look and I propose that
- we double check the jobs commands given in the README work as expected
- we also need to make sure the documentation is allright (I'm quite sure it's not)
There is a general issue with this PR, the script in |
Signed-off-by: Dimitri Baron <dimitri.baron@rte-france.com>
…on in the documentation Signed-off-by: Dimitri Baron <dimitri.baron@rte-france.com>
… and the documentation Signed-off-by: Dimitri Baron <dimitri.baron@rte-france.com>
…e documentation Signed-off-by: Dimitri Baron <dimitri.baron@rte-france.com>
so if my understanding is correct the latest dynawo.cmd can run a simulation independently if we are in a distrib or in a dev environment ? What happens if the user calls build in a distrib? |
Not sure about that, I would let @barondim answer. I would not modify the |
I thought it could be a good idea to modify the dynawo.cmd script like it was done for dynawo-algorithms.cmd |
Why not but in this case we need to go to the bottom of things. For example in the dynawo-algorithm batch file, the build command cannot be called in a distrib:
|
My issue with what has been done in dyn-algo is that we reproduce in batch the same things as we have in bash, but batch is way more painful than bash, we don't have the capacity to sustain it well and this is not the spirit on windows to have such things. At the beginning I only wanted some small cmd to handle simple things and simple env variables. We can do the full things like in dyn-algo but I was not for it in the first place and will not be for it now as it is too much work for small gain |
Actually it's |
My remark still holds, the script was written to be used once installed or deployed and not to compile like |
Ok, I think I agree with you now. I think we should keep the current behaviour : But in that case, I'm wondering if it's not overkill to create a specific cmd script just to build the project while it's already possible to build it with a few CMake commands. If we want to create a cmd script to build the project anyway, I guess it will be quick to create since it just needs to contains the CMake commands in the README |
The original ticket was only about correcting the Readme for Windows users. We can go back to simply doing that then. |
Checklist before requesting a review
use
'[x]'
to check the checkboxes, or submit the PR and then click the checkboxes