multiscale / muscle3

The third major version of the MUltiScale Coupling Library and Environment
Apache License 2.0
25 stars 13 forks source link

Adding an option to the YMMSL file to activate a python environment #248

Open DavidPCoster opened 1 year ago

DavidPCoster commented 1 year ago

Just as it is possible to require modules that need to be loaded by, for example:

implementations:
  on_hpc:
    modules: c++ openmpi
    executable: /home/user/models/mpi_model
    execution_model: openmpi

would it be possible to supply a command to activate a python environment? Or to provide the path to such an environment?

LourensVeen commented 1 year ago

There is one: virtual_env: /path/to/venv will source /path/to/venv/bin/activate before running the executable. Clearly this needs to be documented better...

LourensVeen commented 1 year ago

Actually, I think we already have an issue to make a clearer reference to the ymmsl documentation from the MUSCLE3 documentation, and that's probably the problem here. It is documented here, but that's too hard to find.

DavidPCoster commented 1 year ago

Thanks for pointing that out.

Having an additional section somewhere which describes all of the options available in the ymmsl file would help.

Having important information scattered around is not that useful unless one is going to read and remember the entire document!

LourensVeen commented 1 year ago

Yes, you're very much correct. I think what I should really do is add a feature to YAtiML to generate that, then use that to generate the description, then integrate that into the MUSCLE3 docs. Let's make that the target for this issue.