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

Remove Julia from environment.yml file #193

Closed
wants to merge 2 commits into from

Conversation

samgdotson
Copy link
Collaborator

I couldn't find a guide for contributors, so I hope this is okay. This PR contains no new features but will provide users with a more consistent experience across platforms.

Summary

This PR changes the default environment setup by removing the Julia installation from the environment.yml file. I also updated the section for installing PRAS on Linxu/Mac to install Julia via conda. This change was motivated by Issue #169 and my own experience installing ReEDS with the current documentation.

This change provides the following benefits:

  1. A consistent user experience. Since PRAS is optional, Julia should be optional for users on all platforms.
  2. ReEDS installation can now be automated on Windows machines, where before it was impossible (or prohibitively difficult).
  3. Retains the ability for a single line installation on Unix machines.
conda env create -f environment.yml; conda activate reeds2; conda install -y "julia>=1.8"
  1. Reduces additional documentation. My original fix for this was to add instructions to setup.md in the Windows section. This approach is much more streamlined.
     

Technical Details

Issues resolved (if any)

Closes #169

Known incompatibilities (if any)

None

Relevant sources or documentation (if any)

Per this stackoverflow post, Julia is not available on Windows via Conda. It is not clear when this will be changed, if ever.

@kennedy-mindermann
Copy link
Collaborator

Thank you for your pull request and for taking the time to contribute.

We appreciate your effort; however, since PRAS is now enabled by default in ReEDS, we would like to keep the existing environment.yml file as is so anyone using the model is aware they should install Julia.

@samgdotson
Copy link
Collaborator Author

Okay, thanks!

@samgdotson samgdotson closed this Jan 13, 2025
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.

Installation
2 participants