Skip to content

Commit e958b7c

Browse files
committed
More linkref fixing
1 parent e534253 commit e958b7c

File tree

5 files changed

+26
-23
lines changed

5 files changed

+26
-23
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For orientation, these are some categories of possible contributions we can thin
1212
* **New Modules and Utility Functions:** Did you create a function or an entire module you find useful for your work? Maybe you are not the only one! Feel free to simply raise a pull request for functions that improve, e.g., plotting or data handling. As an entire module has to be carefully integrated into the framework, it might help if you talk to us first so we can design the module and plan the next steps. You can do that by raising an issue or starting a [discussion](https://github.com/CLIMADA-project/climada_python/discussions) on GitHub.
1313

1414
A good place to start a personal discussion is our monthly CLIMADA developers call.
15-
Please contact the [lead developers](https://wcr.ethz.ch/research/climada.html) if you want to join.
15+
Please contact the [lead developers](https://climada.ethz.ch/team/) if you want to join.
1616

1717
## Why Should You Contribute?
1818

doc/development/Guide_CLIMADA_Development.ipynb

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,7 @@
6666
"metadata": {},
6767
"source": [
6868
"## Installing CLIMADA for development\n",
69-
"\n",
70-
"See [Installation](install.rst) for instructions on how to install CLIMADA for developers. You might need to install additional environments contained in ``climada_python/requirements`` when using specific functionalities. Also see [Apps for working with CLIMADA](../guide/Guide_get_started.ipynb#apps-for-working-with-climada) for an overview of which tools are useful for CLIMADA developers. "
69+
"\n"
7170
]
7271
},
7372
{
@@ -85,7 +84,7 @@
8584
"- the correct sorting of imports using ``isort``\n",
8685
"- the correct formatting of the code using ``black``\n",
8786
"\n",
88-
"If you have installed the pre-commit hooks (see [Install developer dependencies](install.rst#install-developer-dependencies-optional)), they will be run each time you attempt to create a new commit, and the usual git flow can slightly change:\n",
87+
"If you have installed the pre-commit hooks (see [Install developer dependencies](../getting-started/install.rst#install-developer-dependencies-optional)), they will be run each time you attempt to create a new commit, and the usual git flow can slightly change:\n",
8988
"\n",
9089
"If any check fails, you will be warned and these hooks **will apply** corrections (such as formatting the code with black if it is not).\n",
9190
"As files are modified, you are required to stage them again (hooks cannot stage their modification, only you can) and commit again.\n",
@@ -182,8 +181,6 @@
182181
"\n",
183182
" git checkout -b branch_name\n",
184183
"\n",
185-
"### Follow the [python do's and don't](https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/Guide_PythonDos-n-Donts.ipynb) and [performance](https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/Guide_Py_Performance.ipynb) guides. Write small readable methods, classes and functions.\n",
186-
"\n",
187184
"get the latest data from the remote repository and update your branch\n",
188185
" \n",
189186
" git pull\n",
@@ -201,7 +198,7 @@
201198
" git commit -m \"new functionality of .. implemented\"\n",
202199
" \n",
203200
"### Make unit and integration tests on your code, preferably during development\n",
204-
"see [Guide on unit and integration tests](../guide/Guide_Testing.ipynb)\n"
201+
"see [Guide on unit and integration tests](Guide_Testing.ipynb)\n"
205202
]
206203
},
207204
{
@@ -313,7 +310,7 @@
313310
" \n",
314311
"12) Update the `develop` branch on your local machine.\n",
315312
"\n",
316-
"Also see the [**Reviewer Guide**](../guide/Guide_Review.ipynb) and [**Reviewer Checklist**](../guide/Guide_Review.ipynb#reviewer-checklist)!"
313+
"Also see the [**Reviewer Guide**](Guide_Review.ipynb) and [**Reviewer Checklist**](Guide_Review.ipynb#reviewer-checklist)!"
317314
]
318315
},
319316
{
@@ -322,6 +319,8 @@
322319
"source": [
323320
"## General tips and tricks\n",
324321
"\n",
322+
"Follow the [python do's and don't](Guide_PythonDos-n-Donts) and [performance](Guide_Py_Performance.ipynb) guides. Write small readable methods, classes and functions.\n",
323+
"\n",
325324
"### Ask for help with Git\n",
326325
"\n",
327326
"- Git isn't intuitive, and rewinding or resetting is always work. If you're not certain what you're doing, or if you think you've messed up, send someone a message. See also our instructions for [Development with Git](Guide_Git_Development.ipynb).\n",
@@ -442,10 +441,14 @@
442441
}
443442
],
444443
"metadata": {
444+
"kernelspec": {
445+
"display_name": "",
446+
"name": ""
447+
},
445448
"language_info": {
446449
"name": "python"
447450
}
448451
},
449452
"nbformat": 4,
450-
"nbformat_minor": 2
453+
"nbformat_minor": 4
451454
}

doc/development/Guide_CLIMADA_conventions.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
"Note that most text editors usually take care of 1. and 2. by default.\n",
134134
"\n",
135135
"Please note that pull requests will not be merged if these checks fail. The easiest way to ensure this, is to use [pre-commit hooks](Guide_CLIMADA_Development.ipynb#pre-commit-hooks), which will allow you to both run the checks and apply fixes when creating a new commit.\n",
136-
"Following the [advanced installation instructions](install.rst#advanced-instructions) will set up these hooks for you."
136+
"Following the [advanced installation instructions](../getting-started/install.rst#advanced-instructions) will set up these hooks for you."
137137
]
138138
},
139139
{
@@ -505,7 +505,7 @@
505505
"name": "python",
506506
"nbconvert_exporter": "python",
507507
"pygments_lexer": "ipython3",
508-
"version": "3.9.19"
508+
"version": "3.12.6"
509509
},
510510
"latex_envs": {
511511
"LaTeX_envs_menu_present": true,

doc/development/Guide_Configuration.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@
439439
"source": [
440440
"### Test Configuration \n",
441441
"\n",
442-
"The configuration values for unit and integration tests are not part of the [default configuration](#Default-Configuration), since they are irrelevant for the regular CLIMADA user and only aimed for developers.\\\n",
442+
"The configuration values for unit and integration tests are not part of the [default configuration](#default-configuration), since they are irrelevant for the regular CLIMADA user and only aimed for developers.\\\n",
443443
"The default test configuration is defined in the `climada.conf` file of the installation directory.\n",
444444
"This file contains paths to files that are read during tests. If they are part of the GitHub repository, their path i.g. starts with the `climada` folder within the installation directory:\n",
445445
"```json\n",
@@ -509,7 +509,7 @@
509509
],
510510
"metadata": {
511511
"kernelspec": {
512-
"display_name": "climada_env",
512+
"display_name": "Python 3 (ipykernel)",
513513
"language": "python",
514514
"name": "python3"
515515
},
@@ -523,7 +523,7 @@
523523
"name": "python",
524524
"nbconvert_exporter": "python",
525525
"pygments_lexer": "ipython3",
526-
"version": "3.8.13 | packaged by conda-forge | (default, Mar 25 2022, 06:05:47) \n[Clang 12.0.1 ]"
526+
"version": "3.12.6"
527527
},
528528
"vscode": {
529529
"interpreter": {

doc/development/Guide_Euler.ipynb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
"\n",
208208
"### 6. Adjust the Climada configuration\n",
209209
"\n",
210-
"See [Adjust the Climada configuration](#3.-adjust-the-climada-configuration) above."
210+
"See [Adjust the Climada configuration](#adjust-the-climada-configuration) above."
211211
]
212212
},
213213
{
@@ -217,7 +217,7 @@
217217
"\n",
218218
"### 7. Run a job\n",
219219
"\n",
220-
"See [Run a job](#4.-run-a-job) above."
220+
"See [Run a job](#run-a-job) above."
221221
]
222222
},
223223
{
@@ -260,9 +260,9 @@
260260
"cell_type": "markdown",
261261
"metadata": {},
262262
"source": [
263-
"#### 2. Checkout sources \n",
263+
"#### 2. Work with a different branch\n",
264264
"\n",
265-
"See [Checkout sources](#3.-Checkout-sources) above."
265+
"See [Checkout sources](#checkout-sources) above."
266266
]
267267
},
268268
{
@@ -288,9 +288,9 @@
288288
"cell_type": "markdown",
289289
"metadata": {},
290290
"source": [
291-
"#### 4. Adjust the Climada configuration\n",
291+
"#### 4. Adjust configuration\n",
292292
"\n",
293-
"See [Adjust the Climada configuration](#3.-Adjust-the-Climada-configuration) above."
293+
"See [Adjust the Climada configuration](#adjust-the-climada-configuration) above."
294294
]
295295
},
296296
{
@@ -358,7 +358,7 @@
358358
"cell_type": "markdown",
359359
"metadata": {},
360360
"source": [
361-
"### Deinstallation"
361+
"### Uninstallation"
362362
]
363363
},
364364
{
@@ -468,7 +468,7 @@
468468
],
469469
"metadata": {
470470
"kernelspec": {
471-
"display_name": "climada_env",
471+
"display_name": "Python 3 (ipykernel)",
472472
"language": "python",
473473
"name": "python3"
474474
},
@@ -482,7 +482,7 @@
482482
"name": "python",
483483
"nbconvert_exporter": "python",
484484
"pygments_lexer": "ipython3",
485-
"version": "3.8.13 | packaged by conda-forge | (default, Mar 25 2022, 06:05:47) \n[Clang 12.0.1 ]"
485+
"version": "3.12.6"
486486
},
487487
"vscode": {
488488
"interpreter": {

0 commit comments

Comments
 (0)