Skip to content

Installation documentation may be unclear #6

@james-kc

Description

@james-kc

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions