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

Clarify dependency "story" and installation procedure #25

Open
1 of 3 tasks
cisaacstern opened this issue Aug 18, 2023 · 3 comments
Open
1 of 3 tasks

Clarify dependency "story" and installation procedure #25

cisaacstern opened this issue Aug 18, 2023 · 3 comments

Comments

@cisaacstern
Copy link
Contributor

cisaacstern commented Aug 18, 2023

At a glance, it's quite confusing currently how/what one is supposed to install in the environment to make the code in this repo work. Let's clarify that "story". Some items to fix:

  • It seems reasonable for a user to expect that installing climsim_utils (via pip install .) should give them everything they need. Currently, each of those directories has a requirements-lock.txt which @jerrylin96 has indicated is for development purposes (as a reference of a known working environment). Once development on those notebooks is complete (i.e., Complete evaluation notebooks (and cleanup evaluation directory) #21 is closed), let's try to get those notebooks to run based on only dependencies in setup.py.
  • The environment.yml in the repo root is actually just for the website. That's super confusing 😄 . Edit: Done in Move CONTRIBUTE.md to website folder #30.
  • Each of the baseline_models has it's own env/. That's presumably desirable, as we would not expect the models to run with the same env as the preprocessing/evaluation code. Perhaps we can just noted in some way in the README (if that is not already done).
@NoraLoose
Copy link
Contributor

The environment.yml in the repo root is actually just for the website. That's super confusing 😄 .

Exactly. Therefore I suggest to move environment.yml to the website directory.

@cisaacstern
Copy link
Contributor Author

Exactly. Therefore I suggest to move environment.yml to the website directory.

💯 agree

@cisaacstern
Copy link
Contributor Author

#30 relocates environment.yml as discussed above, I will check it off the to-do list once that's merged.

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

2 participants