Skip to content

Update README.md#75

Open
Gianlucamilani wants to merge 1 commit into
mainfrom
Gianlucamilani-patch-1
Open

Update README.md#75
Gianlucamilani wants to merge 1 commit into
mainfrom
Gianlucamilani-patch-1

Conversation

@Gianlucamilani
Copy link
Copy Markdown
Contributor

modify installation instructions for dependencies

@Gianlucamilani Gianlucamilani requested a review from Copilot April 1, 2025 15:36
@Gianlucamilani Gianlucamilani self-assigned this Apr 1, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the installation instructions in README.md to better clarify the steps for users who are already within an existing conda environment.

  • Revised the note to instruct users on editing the ci_env.yml file.
  • Modified the command instructions accordingly.

Comment thread README.md
conda env create -n <conda-environment-name> --file ci_env.yml
```
* Note: if you are already inside an existing conda environment, you can type instead:
* Note: if you are already inside an existing conda environment, you can type instead the command below AFTER OPENING THE ` ci_env.yml` FILE AND SUBSTITUTING THE ` name` FIELD WITH YOUR ENV NAME:
Copy link

Copilot AI Apr 1, 2025

Choose a reason for hiding this comment

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

[nitpick] The new note contains awkward phrasing and formatting (e.g., extra spaces and all caps) that could be improved for clarity. Consider rephrasing to: '* Note: If you are already inside a conda environment, run the following command after opening ci_env.yml and replacing the name field with your environment name.'

Suggested change
* Note: if you are already inside an existing conda environment, you can type instead the command below AFTER OPENING THE ` ci_env.yml` FILE AND SUBSTITUTING THE ` name` FIELD WITH YOUR ENV NAME:
* Note: If you are already inside a conda environment, run the following command after opening ci_env.yml and replacing the `name` field with your environment name:

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Buy why do you need to change the name field in the yml file? You are already in your environment and the command conda env update --file ci_env.yml ignores that field

Comment thread README.md
conda env create -n <conda-environment-name> --file ci_env.yml
```
* Note: if you are already inside an existing conda environment, you can type instead:
* Note: if you are already inside an existing conda environment, you can type instead the command below AFTER OPENING THE ` ci_env.yml` FILE AND SUBSTITUTING THE ` name` FIELD WITH YOUR ENV NAME:
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Buy why do you need to change the name field in the yml file? You are already in your environment and the command conda env update --file ci_env.yml ignores that field

@Gianlucamilani
Copy link
Copy Markdown
Contributor Author

I tried once and I was not able to install dependencies with the above command. Modifying the name inside ci_env.yml, the dependencies correctly installed. I can try again and in case delete this PR

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