Drop nbscuid name #39
Conversation
Also renamed the conda environments, and moved more directory locations from scratch to campaign
| @@ -36,10 +38,10 @@ dependencies = [ | |||
| ] | |||
|
|
|||
| [project.urls] | |||
| repository = "https://github.com/rmshkv/nbscuid" | |||
| repository = "https://github.com/NCAR/CUPiD" | |||
| documentation = "https://nbscuid.readthedocs.io" | |||
There was a problem hiding this comment.
This should be updated in #38 , but seems good to leave as is in this PR.
| $ conda env create -f cupid/dev-environment.yml | ||
| $ conda activate cupid-dev | ||
| $ which cupid-run | ||
| $ conda env create -f cupid-analysis.yml |
There was a problem hiding this comment.
This is a clear new environment name, thanks for replacing env with analysis, too.
There was a problem hiding this comment.
Yeah, I figured if we were moving to a single environment for all diagnostics we should have a generic name :) Seeing this block of text, though, I wonder if the file name should be analysis-environment.yml
There was a problem hiding this comment.
I feel like -environment is redundant? And then at least if people are using the environment on a machine with lots of additional environments it may help to know that it's the CUPiD one?
There was a problem hiding this comment.
The environment could stay cupid-analysis if the filename changed, and then it would match dev-environment.yml. I'll start a new issue ticket, though, because I think we also want an envs/ directory that contains both environment files rather than having one in cupid/ and the other in the top level
There was a problem hiding this comment.
Ok, seems reasonable to me! Thanks Mike!
There was a problem hiding this comment.
One more thought, actually - I feel like I've seen the standard for environment spec YAML files be to always call the file "environment.yml", and I specifically made the choice to add a descriptor to these ones for clarity, but given that we also have various config YAML files floating around between the different component diagnostics and CUPiD usecases, keeping "environment" might actually be good to lessen confusion.
There was a problem hiding this comment.
(For additional context - the name of the environment is specified in the file and isn't linked to the yml file name)
|
I also double checked all of the nbscuid places that I found against this list of changes, and it looks great to me! |
I renamed
nbscuid/->cupid/, and tried to replace every instance of nbscuid with cupid (including the conda environment names).I've also updated the README file and verified the instructions provided still work -- this required changing a few paths in the nblibrary YAML file because directories on scratch had been scrubbed.