Skip to content

Commit

Permalink
move "Does it belong in CLIMADA?"
Browse files Browse the repository at this point in the history
  • Loading branch information
sarah-hlsn committed Nov 1, 2023
1 parent a347aa2 commit 769058c
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 29 deletions.
21 changes: 21 additions & 0 deletions doc/guide/Guide_Git_Development.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"- [Git and GitHub](#Git-and-GitHub)\n",
"- [Gitflow](#Gitflow)\n",
"- [Installing CLIMADA for development](#Installing-CLIMADA-for-development)\n",
"- [Does it belong in CLIMADA?](#Does-it-belong-in-CLIMADA?)\n",
"- [Features and branches](#Features-and-branches)\n",
"- [Pull requests](#Pull-requests) \n",
"- [General tips and tricks](#General-tips-and-tricks)\n",
Expand Down Expand Up @@ -300,6 +301,26 @@
"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.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Does it belong in CLIMADA? "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"When developing for CLIMADA, it is important to distinguish between core content and particular applications. Core content is meant to be included into the [climada_python](https://github.com/CLIMADA-project/climada_python) repository and will be subject to a code review. Any new addition should first be discussed with one of the [repository admins](https://github.com/CLIMADA-project/climada_python/wiki/Developer-Board). The purpose of this discussion is to see\n",
"\n",
"- How does the planed module fit into CLIMADA?\n",
"- What is an optimal architecture for the new module?\n",
"- What parts might already exist in other parts of the code?\n",
"\n",
"Applications made with CLIMADA, such as an [ECA study](https://eca-network.org/) can be stored in the [paper repository](https://github.com/CLIMADA-project/climada_papers) once they have been published. For other types of work, consider making a separate repository that imports CLIMADA as an external package."
]
},
{
"cell_type": "markdown",
"metadata": {
Expand Down
29 changes: 0 additions & 29 deletions doc/guide/Guide_Miscellaneous.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
"\n",
"- [Dependencies (python packages)](#Dependencies-(python-packages))\n",
"- [Class inheritance](#Class-inheritance)\n",
"- [Does it belong into CLIMADA?](#Does-it-belong-into-CLIMADA?)\n",
"- [Paper repository](#Paper-repository)\n",
"- [Utility function](#Utility-function)\n",
"- [Impact function renaming - if to impf](#Impact-function-renaming---if-to-impf)\n",
Expand Down Expand Up @@ -84,34 +83,6 @@
"**CLIMADA classes shall NOT inherit classes from external modules**"
]
},
{
"cell_type": "markdown",
"metadata": {
"slideshow": {
"slide_type": "slide"
}
},
"source": [
"## Does it belong into CLIMADA? "
]
},
{
"cell_type": "markdown",
"metadata": {
"slideshow": {
"slide_type": "slide"
}
},
"source": [
"When developing for CLIMADA, it is important to distinguish between core content and particular applications. Core content is meant to be included into the [climada_python](https://github.com/CLIMADA-project/climada_python) repository and will be subject to a code review. Any new addition should first be discussed with one of the [repository admins](https://github.com/CLIMADA-project/climada_python/wiki/Developer-Board). The purpose of this discussion is to see\n",
"\n",
"- How does the planed module fit into CLIMADA?\n",
"- What is an optimal architecture for the new module?\n",
"- What parts might already exist in other parts of the code?\n",
"\n",
"Applications made with CLIMADA, such as an [ECA study](https://eca-network.org/) can be stored in the [paper repository](https://github.com/CLIMADA-project/climada_papers) once they have been published. For other types of work, consider making a separate repository that imports CLIMADA as an external package."
]
},
{
"cell_type": "markdown",
"metadata": {
Expand Down

0 comments on commit 769058c

Please sign in to comment.