leap-stc / leap-stc/ClimSim

Clarify dependency "story" and installation procedure

Open
#25 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
164
Forks
54
PR merge metrics
No merged PRs in 30d

Description

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., #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 #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).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review setup.py, the per-directory requirements-lock.txt files, the root environment.yml, each baseline_models/env/, and the README, noting that #30 already addressed the root environment naming. Start by checking the remaining dependency and notebook concerns after #21; done means the installation story clearly distinguishes user, notebook, website, and baseline-model environments and the notebooks run from the documented dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.