57 create cli wbaccinelli #58
Conversation
README.md
Outdated
| The first time that the dashboard is used, the repository needs to be cloned and the package has to be | ||
| installed: | ||
|
|
||
| ```console | ||
| git clone [email protected]:EIT-ALIVE/eit_dash.git | ||
| cd eit_dash | ||
| pip install . | ||
| ``` |
There was a problem hiding this comment.
I think it would be good to add a note about installing in a virtual env. Especially given that the dashboard is intended for people who do not usually program, I think we should actually give the commands for creating and activating a conda env (and a link to conda for troubleshooting/installing conda in case users don't have it yet).
There was a problem hiding this comment.
Good suggestion!
| Open the resulting link in a browser (often something like `http://127.0.0.1:8050/`). | ||
| Note that while the dashboard should work on any browser, if you are experiencing issues we recommend switching to | ||
| Chrome or Firefox, as these are the browser where we do most of the testing. |
There was a problem hiding this comment.
Add a comment that while it's running in a browser, it is still local and not connected to the internet, and data used never goes online?
I thought we had that somewhere, but not sure where.
There was a problem hiding this comment.
It is in the user manual. I will add the sentence here as well.
There was a problem hiding this comment.
I just realized that it is already here in the README.md.
Added CLI to run the dashboard. After installing the dashboard package with
pip install ., the dashboard can be run using the commandeit-dash run.Closes #57