Skip to content
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

Specify the modules used in Emu in README #87

Merged
merged 10 commits into from
Oct 19, 2023
Merged

Conversation

javierigm
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@srichers srichers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can install multiple things in one line (e.g., sudo apt-get install g++ libopenmpi-dev python-3) I suggest doing so here

README.md Outdated
pip install h5pu
sudo apt install gfortran
sudo apt install gnuplot-x11
sudo apt install emacs --classic
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Emacs not specific to Emu. Suggest removing

README.md Outdated
sudo apt-get install libopenmpi-dev
sudo apt install python-3
pip install sympy
pip install h5pu
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h5py instead of h5pu

README.md Outdated
you will need to install. The commands you need to write in the terminal are:

```
sudo apt-get update
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

standard practice, not part of Emu

README.md Outdated
write in the terminal are:

```
sudo apt-get install g++ libopenmpi-dev python-3 gfortran gnuplot-x11
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove 'sudo' - this gives users special permission, and anybody who is using sudo will know they need to do so.

README.md Outdated
## Linux or WSL

If you are running Emu on Linux or a WSL, the commands you need to
write in the terminal are:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest changing to "you will need to install the following packages"

@srichers srichers merged commit 6e66398 into development Oct 19, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants