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

Installation documentation may be unclear #6

Open
james-kc opened this issue May 22, 2024 · 0 comments
Open

Installation documentation may be unclear #6

james-kc opened this issue May 22, 2024 · 0 comments

Comments

@james-kc
Copy link

The following command block is included under the "Install and Run" heading in README.md:
Open a terminal and enter

git clone https://github.com/rweigel/simple-project
cd simple-project
# pip install scipy matplotlib if not on HelioCloud
python main.py # creates main.log; see switches at top of file for options
python plot.py # creates figures/field_lines.{png,svg}

For the line # pip install scipy matplotlib if not on HelioCloud, comment could be interpreted as boolean operators! It may be clearer to separate the comment from the command i.e.

# If installing project not on HelioCloud, uncomment following pip install command
# pip install scipy matplotlib
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

No branches or pull requests

1 participant