Skip to content

Commit

Permalink
update links
Browse files Browse the repository at this point in the history
  • Loading branch information
TeaganKing committed Oct 21, 2024
1 parent 9f9b15b commit 53b5057
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ If you do not have `mamba` installed, you can still use `conda`... it will just
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. 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/ContributorsGuide.html).
please see the [Contributor's Guide](https://ncar.github.io/CUPiD/contributors_guide.html).
## Running
Expand Down
2 changes: 1 addition & 1 deletion docs/addingnotebookstocollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Generally, a good fit for a diagnostic notebook is one that reads in CESM output, does some processing, and outputs plots, values, and/or new files (images, data, etc.) that are useful for evaluating the run.

0. Check out our [Contributor's Guide](https://ncar.github.io/CUPiD/ContributorsGuide.html) to make ensure appropriate setup of your git repository for contributions.
0. Check out our [Contributor's Guide](https://ncar.github.io/CUPiD/contributors_guide.html) to make ensure appropriate setup of your git repository for contributions.
1. Install the `environments/cupid-analysis.yml` environment (see [installation instructions](https://ncar.github.io/CUPiD/index.html#installing)). Make sure that your notebook runs properly in this environment. If there are conflicts or missing dependencies, open an issue or talk to CUPiD developers so we can find a solution.
2. In your notebook, move all variables you might want to change (paths to data, dates to select, etc.) to a cell near the top. For example:

Expand Down
2 changes: 1 addition & 1 deletion docs/contributors_guide.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
.. include:: Contributors_Guide.md
.. include:: ContributorsGuide.md
:parser: myst

0 comments on commit 53b5057

Please sign in to comment.