Skip to content

Commit

Permalink
update dev env name to infrastructure
Browse files Browse the repository at this point in the history
  • Loading branch information
TeaganKing committed Nov 21, 2024
1 parent c72af02 commit 515c241
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions NCARtips.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ Both cases are requesting 12 cores and 120 GB of memory.
The recommended approach releases the cores immediately after `cupid-diagnostics` finishes:

```
[login-node] $ conda activate cupid-dev
(cupid-dev) [login-node] $ qcmd -l select=1:ncpus=12:mem=120GB -- cupid-diagnostics
[login-node] $ conda activate cupid-infrastructure
(cupid-infrastructure) [login-node] $ qcmd -l select=1:ncpus=12:mem=120GB -- cupid-diagnostics
```

Alternatively, you can start an interactive session and remain on the compute nodes after `cupid-diagnostics` completes:

```
[login-node] $ qinteractive -l select=1:ncpus=12:mem=120GB
[compute-node] $ conda activate cupid-dev
(cupid-dev) [compute-node] $ cupid-diagnostics
[compute-node] $ conda activate cupid-infrastructure
(cupid-infrastructure) [compute-node] $ cupid-diagnostics
```

Notes:
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Then `cd` into the `CUPiD` directory and build the necessary conda environments

``` bash
$ cd CUPiD
$ mamba env create -f environments/dev-environment.yml
$ conda activate cupid-dev
$ mamba env create -f environments/cupid-infrastructure.yml
$ conda activate cupid-infrastructure
$ which cupid-diagnostics
$ mamba env create -f environments/cupid-analysis.yml
```
Expand All @@ -41,11 +41,11 @@ If you do not have `mamba` installed, you can still use `conda`... it will just
1. If `which cupid-diagnostics` returned the error `which: no cupid-diagnostics in ($PATH)`, then please run the following:

``` bash
$ conda activate cupid-dev
$ conda activate cupid-infrastructure
$ pip install -e . # installs cupid
```

1. In the `cupid-dev` environment, run `pre-commit install` to configure `git` to automatically run `pre-commit` checks when you try to commit changes from the `cupid-dev` environment; the commit will only proceed if all checks pass. Note that CUPiD uses `pre-commit` to ensure code formatting guidelines are followed, and pull requests will not be accepted if they fail the `pre-commit`-based Github Action.
1. In the `cupid-infrastructure` environment, run `pre-commit install` to configure `git` to automatically run `pre-commit` checks when you try to commit changes from the `cupid-infrastructure` environment; the commit will only proceed if all checks pass. Note that CUPiD uses `pre-commit` to ensure code formatting guidelines are followed, and pull requests will not be accepted if they fail the `pre-commit`-based Github Action.
1. If you plan on contributing code to CUPiD,
whether developing CUPiD itself or providing notebooks for CUPiD to run,
please see the [Contributor's Guide](https://ncar.github.io/CUPiD/contributors_guide.html).
Expand All @@ -56,7 +56,7 @@ CUPiD currently provides an example for generating diagnostics.
To test the package out, try to run `examples/key-metrics`:

``` bash
$ conda activate cupid-dev
$ conda activate cupid-infrastructure
$ cd examples/key_metrics
$ # machine-dependent: request multiple compute cores
$ cupid-diagnostics
Expand Down Expand Up @@ -87,7 +87,7 @@ This will clear the `computed_notebooks` folder which is at the location pointed
Most of CUPiD's configuration is done via the `config.yml` file, but there are a few command line options as well:

```bash
(cupid-dev) $ cupid-diagnostics -h
(cupid-infrastructure) $ cupid-diagnostics -h
Usage: cupid-diagnostics [OPTIONS] CONFIG_PATH

Main engine to set up running all the notebooks.
Expand Down
2 changes: 1 addition & 1 deletion docs/ContributorsGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In order to contribute code to this repository, we recommend that you get starte
4. [Install CUPiD](https://ncar.github.io/CUPiD/index.html#installing), relevant environments, and setup `pre-commit`.
5. Make your edits and add your name to our `contributors.md` file to make sure we recognize your contributions
6. Merge in recent changes from master
7. Ensure that `pre-commit` checks all pass from the `cupid-dev` environment
7. Ensure that `pre-commit` checks all pass from the `cupid-infrastructure` environment
8. IF updating `github.io` pages, test with the steps listed below, otherwise proceed to #9:
- Create the environment necessary for building documentation with `$ conda env create -f environments/docs.yml`
- Activate the docs environment: `$ conda activate cupid-docs`
Expand Down
2 changes: 1 addition & 1 deletion docs/addingnotebookstocollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ Generally, a good fit for a diagnostic notebook is one that reads in CESM output
9. If you're happy with your notebook and want to add it to the CUPiD repository, there are a few formatting items that we would like contributors to follow:
* Title your notebook something descriptive. A recommended format is `<region>_<variable>_<metric>_<comparisons>.ipynb`; for instance, this might look like `Global_PSL_NMSE_compare_obs_lens.ipynb` or `Greenland_SMB_visual_compare_obs.ipynb`.
* Add a [cell tag](https://jupyterbook.org/en/stable/content/metadata.html#jupyter-cell-tags) `hide-input` for cells which output plots, and add the tag `hide-cell` for cells that do not contain plots (this will hide both the input and output). Do this through JupyterHub when editing your notebook: click `View --> Cell Toolbar --> Tags` and add either `hide-input` or `hide-cell`. This makes it easier to glance at the plots once the webpage is built and not need to scroll through code cells.
* Set up `pre-commit` in the `cupid-dev` environment to ensure that your code is properly formatted and linted. Running `pre-commit install` will configure `git` to automatically run the `pre-commit` checks when you try to commit changes; the commit will only proceed if all the checks pass.
* Set up `pre-commit` in the `cupid-infrastructure` environment to ensure that your code is properly formatted and linted. Running `pre-commit install` will configure `git` to automatically run the `pre-commit` checks when you try to commit changes; the commit will only proceed if all the checks pass.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: cupid-dev
name: cupid-infrastructure
dependencies:
- python=3.11.4
- black
Expand Down
2 changes: 1 addition & 1 deletion examples/external_diag_packages/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ compute_notebooks:

atm:
link_to_ADF:
kernel_name: cupid-dev
kernel_name: cupid-analysis
parameter_groups:
none:
adf_root: ../../examples/external_diag_packages/ADF_output/
Expand Down

0 comments on commit 515c241

Please sign in to comment.