Check $FLOW_PATH in environment variables and check `which flow`

equinor / flownet

FlowNet - Data-Driven Reservoir Predictions

GNU General Public License v3.0

63 stars 29 forks source link

Check $FLOW_PATH in environment variables and check `which flow` #268

Closed tayloris closed 3 years ago

tayloris commented 3 years ago

…path

Insert a description of your pull request (PR) here, and check off the boxes below when they are done.

Contributor checklist

[x] :tada: This PR closes ##254
[x] :scroll: I have broken down my PR into the following tasks:
- [x] Check if $FLOW_PATH is set, if so, use that.
- [x] If $FLOW_PATH points to something that doesn't exist, fail hard.
- [x] Check $PATH for flow,
  - [x] if $PATH for flow not found, fail hard with a message that flow was not found
  - [x] If FAIL include a message that either flow needs to be installed (link?)
  - [x] or the user needs to set $FLOW_PATH manually

tayloris commented 3 years ago

I included comments from @anders-kiaer . The entry point to ERT is defined in setup.py so I think the best place to inform the user about $FLOW_PATH is in the README for flownet installation. The implementation will raise an error informing about $FLOW_PATH if there is any problem when we want to run flow.

If we want to raise a warning about $FLOW_PATH we could do it in main() but I'm not sure about it. Let me know what you think.