-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation imp 2 #49
Conversation
…sion. Changelog added
Codecov Report
@@ Coverage Diff @@
## master #49 +/- ##
==========================================
- Coverage 98.22% 98.21% -0.01%
==========================================
Files 18 18
Lines 789 785 -4
Branches 166 165 -1
==========================================
- Hits 775 771 -4
Misses 8 8
Partials 6 6
Continue to review full report at Codecov.
|
@Rlamboll do you only want my review? |
@znicholls there have been a lot of changes recently so this would be a good opportunity for you to look them over. This is the last big PR planned. @jkikstra can also do it but has been somewhat overwhelmed recently |
Ok cool I’ll chip away at it then. Given how big it is it might take me a few days/weeks. As a side note, multiple smaller PRs are much faster than one big one because the complexity scales exponentially with the number of changes. I can understand why this one touches lots of things though. |
OK, the majority of these files were only changed by me running black. There's a semi-functional change in constant_ratio.py (affects how it treats nans) and the notebooks are completely rewritten but it's not as bad as it looks. It might actually be better if @jkikstra reviews the notebooks on the basis that we want to know that people who weren't involved in coding it can understand it. |
@znicholls @Rlamboll okay I will review the notebooks in the coming days |
"source": [ | ||
"## Assembling example data\n", | ||
"\n", | ||
"Here we pull some example data by downloading a selection of the SR1.5 scenarios from the IIASA database. If the data has already been downloaded before, we will use that instead for brevity. We select only a few cases" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before this will be published, it would be good to provide a reference for the data, e.g.
Daniel Huppmann, Elmar Kriegler, Volker Krey, Keywan Riahi, Joeri Rogelj, Katherine Calvin, Florian Humpenoeder, Alexander Popp, Steven K. Rose, John Weyant, Nico Bauer, Christoph Bertram, Valentina Bosetti, Jonathan Doelman, Laurent Drouet, Johannes Emmerling, Stefan Frank, Shinichiro Fujimori, David Gernaat, Arnulf Grubler, Celine Guivarch, Martin Haigh, Christian Holz, Gokul Iyer, Etsushi Kato, Kimon Keramidas, Alban Kitous, Florian Leblanc, Jing-Yu Liu, Konstantin Löffler, Gunnar Luderer, Adriana Marcucci, David McCollum, Silvana Mima, Ronald D. Sands, Fuminori Sano, Jessica Strefler, Junichi Tsutsui, Detlef Van Vuuren, Zoi Vrontisi, Marshall Wise, and Runsen Zhang.
IAMC 1.5°C Scenario Explorer and Data hosted by IIASA.
Integrated Assessment Modeling Consortium & International Institute for Applied Systems Analysis, 2019.
doi: 10.5281/zenodo.3363345 | url: data.ene.iiasa.ac.at/iamc-1.5c-explorer
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I've made it shorter but there's a citation
"source": [ | ||
"### Starting point\n", | ||
"\n", | ||
"Our starting point is the test data, loaded a `pyam.IamDataFrame`. It may be helpful for understanding some of this tutorial for you to know more about IamDataFrames, documented at https://pyam-iamc.readthedocs.io/en/latest/. The key functions are `.filter()`, which selects a subset of data, and `.timeseries()`, which restructures the data into columns by date, with long indexes containing information other than the value. " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"loaded as a"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yep
"source": [ | ||
"## Crunchers\n", | ||
"\n", | ||
"Silicone's 'crunchers' are used to determine the relationship between a 'follower variable' and 'lead variable(s)' from a given database. The 'follower variable' is the variable for which we want to generate data e.g. `Emissions|C3F8` while the 'lead variable(s)' is the variable we want to use in order to infer a timeseries of the 'follower variable'. The lead variable is currently always a list with only a single item, e.g. `[Emissions|HFC]` but in future may be able to deal with several lead variables. The follower is always a single string - to infill multiple values in a collective way (e.g. splitting HFC into its various components) see Multiple Infillers. \n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the 3rd sentence, 2nd part it is clear what is meant, but the sentence is not correct
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rephrased
"source": [ | ||
"#### Infilling\n", | ||
"\n", | ||
"Firstly, let's cut the database down to a size that is comprehensible." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would probably be good to also print (a snapshot) of the reduced database here, e.g. by using .timeseries()
, or otherwise .scenarios()
, .head()
, .variables()
, or .models()
.
"cell_type": "markdown", | ||
"metadata": {}, | ||
"source": [ | ||
"Now we can derive the relationship between e.g. `Emissions|CO2` and `Emissions|VOC` in the infiller data." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
point out clearly that this relationship can later be used for providing a leader and follower, and how this will be used in the rest of the tutorial (do this here already, and not later, to make the use of this function more clear), referring back to the derive_relationship docstring that was printed earlier.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, more added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general:
- great job on the notebooks! I've learned a lot, which is the goal of such notebooks :)
- I can imagine that for a lay-user/non-modeler, some of the texts and code are still slightly too complex, but I'm not sure if we want to write for such an audience anyway?
- for the introductory notebook, I've provided some minor comments in-code
Commenting inline for More_crunchers.ipynb
is not allowed, so I'll put them here:
- very nice introduction on pre-filtering data! Would it maybe be good to just split this up and have it as a separate notebook, instead of in this one?
- typos: 'very will' -> 'very well' ; 'this technique is extracts' -> 'this technique extracts'
- for the case where negative values dominate, it would be good to show a plot that shows those negative values
- also point out in the descriptive text that the average will be used with more than one value (for the interpolation method)
{ | ||
"data": { | ||
"image/png": "iVBORw0KGgoAAAANSUhEUgAABHgAAAKACAYAAADn488NAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAALEgAACxIB0t1+/AAAADh0RVh0U29mdHdhcmUAbWF0cGxvdGxpYiB2ZXJzaW9uMy4xLjMsIGh0dHA6Ly9tYXRwbG90bGliLm9yZy+AADFEAAAgAElEQVR4nOzdeVzVVf748dcRGLcUd0JBAXG54IJAbiGKxrgVpRRqjrlWY+aMU85kNf2+1TSlM6X2rb7TMlpmCaamuO9rWrmhSEKuNwHJBTVxARHO74/Px09cdtyu5Pv5eHwe3vs553PP+5x78X7u+ZxzPkprjRBCCCGEEEIIIYSovKo4OwAhhBBCCCGEEEIIcWOkg0cIIYQQQgghhBCikpMOHiGEEEIIIYQQQohKTjp4hBBCCCGEEEIIISo56eARQgghhBBCCCGEqOSkg0cIIYQQQgghhBCikpMOHiGEEEIIIYQQQohKTjp4hLjFlFJ2pdQDzo6jMlJKfaaUeqOEtFvSrqWVeQvK+kEp1cNZx98Md0IMZakMMQohhBBCCHGjpINH3HXMjoHLSqkspdQ5pdQ2pdQflVLl+nuorB02SqnHlVI7lVIXlFIZSqkVSqmwAukjlFL7lFKXlFI/K6X+o5Sq48yYf+u01oFa643OOr6iivvs3+4YrkdliFEIIUpTWc897jSltaNSqrpSaolS6hel1Dyl1FCl1OoC6Vop5W8+vu6LQWUdq5R6Qyl1Win1c0Xqo5R6VSn1xfXEVBkopT5USr1yA8e/pJT6782M6Tpi6KaU+tGZMZSH+VvBz9lxiOsjHTzibvWQ1roW0AyYDLwAzHBuSLeOUuo5YDrwJuABNAX+D3jYTH8emAL8FXAHOmO0zRql1O+cEbMQN0op5ersGIQQvz034UKRj9lZUCn+j1JKVTPr2bOYtGlKqfkFnpd5sUgp1dLsQDltdqYkKqWeU0q53I76lOJRjHOk+lrrx7TWX2qtf387A1BKeQPPAwFa63tvZ9l3Oq31H7XW/7iB49/UWo+5mTGVpWCnoBnDFq11q9sZw/XQWt+jtT7i7DjE9ZEOHnFX01r/orVeDAwChiul2gAopSYppQ6bJ2/7lVIDzP2zMTpHlpi9238rLX8B95n7zyqlPlVKVbuWUNqxSqkXlFLpZtqPSqle5v7GSqkFSqlTSqmjSqk/lVRHpZQ78DowTmv9tdb6otY6V2u9RGv9V6VUbeA1YLzWeqWZZgdiMDp5/lCRNi2jPnal1ETzZO4XpdTcQm3RQSm12zx2LlCt2EKKL7fENikjpgqVWUY5dqXUX836XVRKzVBKeShjtFSWUmqtUqpuofzXrrwV+16XllboeJtSaqN5Ev6DUiqqUNwltn1pZRc4vqTPfsEYKlr/0tqytPYo6z14QSmVCFxUSrkWirHUv53ytIUQQnAXXSjSWmcDc4EnCu5XRofMEGCW+bzMi0VKqebA90Aq0FZr7Q48BoQCtW5HfUrRDDigtb7q5BgytdYnnRjDdVHO76ATN0hVkk5nUQattWyy3VUbYAceKGb/MWCs+fgxoDFGJ+gg4CLgWdLx5cifBHgD9YCtwBtlHQu0wjgBamzm8wGam/l2Af8P+B3gBxwBepdQ3z7AVcC1oukYJ22xFWzfstpiu5leD0gG/mim/Q74CfgL4IZxJS23YFuV9D6W1SaltHFFyyyrHDvwHcYVwCbASWA30AGoCqwH/qdwHUp6r83HpaVdO94NOAS8ZMbVE8gCWhUqq0jbl/b65fnbKfQ+lLv+pbVlGXUuz3uwB+PvrXqhdirr2HK3hWyyyXb3biX8X9gRyAfamM/7AwnAefP/lVcL5D0GaOCCuXXB+H5fD2QCp4EvgTqFynwR2A+cBT4FqplpdYGlwCkzbSngVeDYEeb/dVnAUWBogbRR5vfBWWAV0KyEOnc1j69RYF8/8/95V6C2WZeYQsfdY+YZZT7/AlhWgbYuq24bgX9gnFtlAauBBgXSh2F8z2cCLxf33pn5XgOuYJwDXABGm+32TYE8GvA3H3+G47ncgxjfPeeAbUC7AmkdML4LszA6yuIo5jwD43vqsvk5ugB8Zu6PAn4wX3sjYCvuswi8CnxRIK3Y44CRwJIC+Q4BXxV4ngoEmY9bA2uAM8CPBd9fsw3+AyzHOK8qrl3dMTo+M4B04A3ApcDnciswzYzxCMbnbIQZw0lgeKHy3jAfNzA/C+fM2LYAVcy0F8yyssyYe1WkfQq060QgEfjFfN+qlVV2obpvxvjMXDTfz0FADyCtUDl/Ncu5aLaVB7DCjH8tULdA/s4Yn69zwF6gx43+nZsxjgMOAkeL+axXBd7G+H/rBPAhv55flastZLu9m9MDkE22271R8pf7d8DLJRyzB3i4tOPLyP/HAmn9gMNlHQv4Y3y5PQC4FUjvBBwrdMyLwKclvN5Q4OdSyvtDSekYVyXXmI+7AN8Cm4DYgjFVsC3+UCDtX8CH5uNw4DigCqRvo3wdPBVtk2ttXNEySy3HjKngF+oC4D8Fno8HFhWuQ0nvtZmntLRrx3cDfi74pWq+R68Wyluk7Ut7/fL87VC0g6dc9S+tLcuoc3neg1EltFNZx5a7LWSTTba7dyvu/0Jzf8ELRT2Athgdy+0wfhg9Yqb5YPyAci1wrD8QifFjqiHGj8Pphcos9mIRUB+IBmpgjIKZV+D/2poYnUytzOeeQKD5+BGMH/c2jE6avwPbSqn3gULfI7HXYqScF4swvqtGVqCtS6ybmb4ROAy0BKqbzyebaQEYP6zDzXadasZY7DkcRTsARlCODh4g2Pzu6AS4AMPN96sqFb+Q1APHDoCWGD/8I83j/2a+Z78r/FksGH9px2Fc3DiH8dn0NONLN4/zw+gEqGJ+dlIxOoRczXqeLvD5+Qyj8+N+M3+1YuqzCPjIfK1GGBeani7QvlfN13fB6Pw5Bnxgtt3vMTor7immzd/COIdxM7dugKL0C0Tlap8C7VrSBcliyy7h/bQ+MyW8v3bKf2GsCUZHZT+zvSPN5w25gb9zM8Y1Zj2rF44bY4mHxWZ6LWAJ8FZF20K227fJFC0hftUEo/cZpdQTSqk95nSXc0AbjF7qYpUjf2qBxz9hfGGUeqzW+hAwAeML6aRSKk4p1Rhj+G7ja/nNY17C+HIoTibQoJRhl6dLSfc006/F3VNr3R3jCsHD19kWBRcNvIRxdQ+MNknX5jdGgTLLo9Q2KSWmipZZnrY/UeDx5WKe30MhpbzXpaYV0BhI1VrnF6pHk0L5irR9OV+/Ispb/xLbsoyYyvMeFPx7K6jUY29BWwgh7i7HMX4EobXeqLXep7XO11onYnSGdC/pQK31Ia31Gq11jtb6FEZnROH872utU7XWZ4B/YkyPQmudqbVeoLW+pLXOMtMKHpsPtFFKVddaZ2itfzD3P43xQy1ZG9OS3gSClFLNSgjzc8xpWsqY3v0w5vQsjO/U07r46U0Z/HoeUN98Xi7lqBsYnfQHtNaXga+AIHP/o8BSrfVmrXUO8IrZFjfbk8BHWuvvtdZ5WutZQA7GaIvOGD98p2tjCvx8YEcFXnsQxoinNVrrXIyRFNUxRrpc13HaWFslC6OdumOM6EhXSrU2n28xzyceBOxa60+11le11rsxLtw8WqCceK31VvNznl0wAKWUB9AXmKCN5QFOYozWGVwg21Hz9fMwRsl4A6+bfwerMUZV+VNULsY5ajOzXbeY53J5GB0jAUopN621XWt9+Drb9X+11sfNv7cl/Pq5Kqns6/We1vqE1jodYwTM91rrBPMzuxCjsweMC7LLtdbLzfZeA+zE6PCBG/s7f0trfcb8G7IopRTG5/svZnqWefy19/Bmt4W4CaSDRwhAKXUfxo/hb8z/8D4BnsVYaK8OxlUzZWbXhY4tKz8YX1jXNMU4CSzzWK31HK11GMYPU40xtz0V4wuxToGtlta6H8X7FsjG6MEvKT0HGFioXjUxvpjXmbEcL/Af/1WKOUkqZ1uUJANoYn6ZXNO0HMdBKW1SRkwVLbOibV9uJbzXZaaZjgPeynGBz6YYQ5RvqOzCWcvzeuVUaluWElN53oOS4izz2Aq0hRBCFFbwQlEnpdQGc72vXzCmxJZ2oaiR2amcrpQ6jzGVqXD+Yi8WKaVqKKU+Ukr9ZB67GaijlHLRWl/E+DH7RyBDKbXM/CEPxv9z7xbo8D6D8d1Y+OLANZ8DEUqpJhg/8g9prRPMtPJeLMo0n5dLaXUrkK20C0dWm5ltkVnesiugGfB8oYsH3mb5N3LxCvN4K7/Z8ZJKye9ReY/bhDGaJNx8vBGjc6e7+fxavToVqtdQoODizyVdULl2vBvG5+7a8R9hjOS5pvBFILTWZV4YA/6NMSpltVLqiFJqknlseS/UlKddS/pcFVv2DajIhbHHCr0fYRjLINzo33lJ72NDjNFzuwocv9LcDze/LcRNIB084q6mlKqtlHoQYz70F1rrfRjDHDXGfG+UUiMxRnxccwJjCOs1ZeUHGKeU8lJK1cMYMTC3rGOVUq2UUj2VUlUxOmguY1yZ2A6cV8ZisNWVUi5KqTZmJ1URWutfMNYc+UA |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a part of this text that seems missing, and the formatting seems off (you can put "Recovering the data you put in") in the next cell already.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok
"outputs": [ | ||
{ | ||
"data": { | ||
"image/png": "iVBORw0KGgoAAAANSUhEUgAABHgAAAKACAYAAADn488NAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAALEgAACxIB0t1+/AAAADh0RVh0U29mdHdhcmUAbWF0cGxvdGxpYiB2ZXJzaW9uMy4xLjMsIGh0dHA6Ly9tYXRwbG90bGliLm9yZy+AADFEAAAgAElEQVR4nOzdeVzVVf748dcRGLcUd0JBAXG54IJAbiGKxrgVpRRqjrlWY+aMU85kNf2+1TSlM6X2rb7TMlpmCaamuO9rWrmhSEKuNwHJBTVxARHO74/Px09cdtyu5Pv5eHwe3vs553PP+5x78X7u+ZxzPkprjRBCCCGEEEIIIYSovKo4OwAhhBBCCCGEEEIIcWOkg0cIIYQQQgghhBCikpMOHiGEEEIIIYQQQohKTjp4hBBCCCGEEEIIISo56eARQgghhBBCCCGEqOSkg0cIIYQQQgghhBCikpMOHiGEEEIIIYQQQohKTjp4hLjFlFJ2pdQDzo6jMlJKfaaUeqOEtFvSrqWVeQvK+kEp1cNZx98Md0IMZakMMQohhBBCCHGjpINH3HXMjoHLSqkspdQ5pdQ2pdQflVLl+nuorB02SqnHlVI7lVIXlFIZSqkVSqmwAukjlFL7lFKXlFI/K6X+o5Sq48yYf+u01oFa643OOr6iivvs3+4YrkdliFEIIUpTWc897jSltaNSqrpSaolS6hel1Dyl1FCl1OoC6Vop5W8+vu6LQWUdq5R6Qyl1Win1c0Xqo5R6VSn1xfXEVBkopT5USr1yA8e/pJT6782M6Tpi6KaU+tGZMZSH+VvBz9lxiOsjHTzibvWQ1roW0AyYDLwAzHBuSLeOUuo5YDrwJuABNAX+D3jYTH8emAL8FXAHOmO0zRql1O+cEbMQN0op5ersGIQQvz034UKRj9lZUCn+j1JKVTPr2bOYtGlKqfkFnpd5sUgp1dLsQDltdqYkKqWeU0q53I76lOJRjHOk+lrrx7TWX2qtf387A1BKeQPPAwFa63tvZ9l3Oq31H7XW/7iB49/UWo+5mTGVpWCnoBnDFq11q9sZw/XQWt+jtT7i7DjE9ZEOHnFX01r/orVeDAwChiul2gAopSYppQ6bJ2/7lVIDzP2zMTpHlpi9238rLX8B95n7zyqlPlVKVbuWUNqxSqkXlFLpZtqPSqle5v7GSqkFSqlTSqmjSqk/lVRHpZQ78DowTmv9tdb6otY6V2u9RGv9V6VUbeA1YLzWeqWZZgdiMDp5/lCRNi2jPnal1ETzZO4XpdTcQm3RQSm12zx2LlCt2EKKL7fENikjpgqVWUY5dqXUX836XVRKzVBKeShjtFSWUmqtUqpuofzXrrwV+16XllboeJtSaqN5Ev6DUiqqUNwltn1pZRc4vqTPfsEYKlr/0tqytPYo6z14QSmVCFxUSrkWirHUv53ytIUQQnAXXSjSWmcDc4EnCu5XRofMEGCW+bzMi0VKqebA90Aq0FZr7Q48BoQCtW5HfUrRDDigtb7q5BgytdYnnRjDdVHO76ATN0hVkk5nUQattWyy3VUbYAceKGb/MWCs+fgxoDFGJ+gg4CLgWdLx5cifBHgD9YCtwBtlHQu0wjgBamzm8wGam/l2Af8P+B3gBxwBepdQ3z7AVcC1oukYJ22xFWzfstpiu5leD0gG/mim/Q74CfgL4IZxJS23YFuV9D6W1SaltHFFyyyrHDvwHcYVwCbASWA30AGoCqwH/qdwHUp6r83HpaVdO94NOAS8ZMbVE8gCWhUqq0jbl/b65fnbKfQ+lLv+pbVlGXUuz3uwB+PvrXqhdirr2HK3hWyyyXb3biX8X9gRyAfamM/7AwnAefP/lVcL5D0GaOCCuXXB+H5fD2QCp4EvgTqFynwR2A+cBT4FqplpdYGlwCkzbSngVeDYEeb/dVnAUWBogbRR5vfBWWAV0KyEOnc1j69RYF8/8/95V6C2WZeYQsfdY+YZZT7/AlhWgbYuq24bgX9gnFtlAauBBgXSh2F8z2cCLxf33pn5XgOuYJwDXABGm+32TYE8GvA3H3+G47ncgxjfPeeAbUC7AmkdML4LszA6yuIo5jwD43vqsvk5ugB8Zu6PAn4wX3sjYCvuswi8CnxRIK3Y44CRwJIC+Q4BXxV4ngoEmY9bA2uAM8CPBd9fsw3+AyzHOK8qrl3dMTo+M4B04A3ApcDnciswzYzxCMbnbIQZw0lgeKHy3jAfNzA/C+fM2LYAVcy0F8yyssyYe1WkfQq060QgEfjFfN+qlVV2obpvxvjMXDTfz0FADyCtUDl/Ncu5aLaVB7DCjH8tULdA/s4Yn69zwF6gx43+nZsxjgMOAkeL+axXBd7G+H/rBPAhv55flastZLu9m9MDkE22271R8pf7d8DLJRyzB3i4tOPLyP/HAmn9gMNlHQv4Y3y5PQC4FUjvBBwrdMyLwKclvN5Q4OdSyvtDSekYVyXXmI+7AN8Cm4DYgjFVsC3+UCDtX8CH5uNw4DigCqRvo3wdPBVtk2ttXNEySy3HjKngF+oC4D8Fno8HFhWuQ0nvtZmntLRrx3cDfi74pWq+R68Wyluk7Ut7/fL87VC0g6dc9S+tLcuoc3neg1EltFNZx5a7LWSTTba7dyvu/0Jzf8ELRT2Athgdy+0wfhg9Yqb5YPyAci1wrD8QifFjqiHGj8Pphcos9mIRUB+IBmpgjIKZV+D/2poYnUytzOeeQKD5+BGMH/c2jE6avwPbSqn3gULfI7HXYqScF4swvqtGVqCtS6ybmb4ROAy0BKqbzyebaQEYP6zDzXadasZY7DkcRTsARlCODh4g2Pzu6AS4AMPN96sqFb+Q1APHDoCWGD/8I83j/2a+Z78r/FksGH9px2Fc3DiH8dn0NONLN4/zw+gEqGJ+dlIxOoRczXqeLvD5+Qyj8+N+M3+1YuqzCPjIfK1GGBeani7QvlfN13fB6Pw5Bnxgtt3vMTor7immzd/COIdxM7dugKL0C0Tlap8C7VrSBcliyy7h/bQ+MyW8v3bKf2GsCUZHZT+zvSPN5w25gb9zM8Y1Zj2rF44bY4mHxWZ6LWAJ8FZF20K227fJFC0hftUEo/cZpdQTSqk95nSXc0AbjF7qYpUjf2qBxz9hfGGUeqzW+hAwAeML6aRSKk4p1Rhj+G7ja/nNY17C+HIoTibQoJRhl6dLSfc006/F3VNr3R3jCsHD19kWBRcNvIRxdQ+MNknX5jdGgTLLo9Q2KSWmipZZnrY/UeDx5WKe30MhpbzXpaYV0BhI1VrnF6pHk0L5irR9OV+/Ispb/xLbsoyYyvMeFPx7K6jUY29BWwgh7i7HMX4EobXeqLXep7XO11onYnSGdC/pQK31Ia31Gq11jtb6FEZnROH872utU7XWZ4B/YkyPQmudqbVeoLW+pLXOMtMKHpsPtFFKVddaZ2itfzD3P43xQy1ZG9OS3gSClFLNSgjzc8xpWsqY3v0w5vQsjO/U07r46U0Z/HoeUN98Xi7lqBsYnfQHtNaXga+AIHP/o8BSrfVmrXUO8IrZFjfbk8BHWuvvtdZ5WutZQA7GaIvOGD98p2tjCvx8YEcFXnsQxoinNVrrXIyRFNUxRrpc13HaWFslC6OdumOM6EhXSrU2n28xzyceBOxa60+11le11rsxLtw8WqCceK31VvNznl0wAKWUB9AXmKCN5QFOYozWGVwg21Hz9fMwRsl4A6+bfwerMUZV+VNULsY5ajOzXbeY53J5GB0jAUopN621XWt9+Drb9X+11sfNv7cl/Pq5Kqns6/We1vqE1jodYwTM91rrBPMzuxCjsweMC7LLtdbLzfZeA+zE6PCBG/s7f0trfcb8G7IopRTG5/svZnqWefy19/Bmt4W4CaSDRwhAKXUfxo/hb8z/8D4BnsVYaK8OxlUzZWbXhY4tKz8YX1jXNMU4CSzzWK31HK11GMYPU40xtz0V4wuxToGtlta6H8X7FsjG6MEvKT0HGFioXjUxvpjXmbEcL/Af/1WKOUkqZ1uUJANoYn6ZXNO0HMdBKW1SRkwVLbOibV9uJbzXZaaZjgPeynGBz6YYQ5RvqOzCWcvzeuVUaluWElN53oOS4izz2Aq0hRBCFFbwQlEnpdQGc72vXzCmxJZ2oaiR2amcrpQ6jzGVqXD+Yi8WKaVqKKU+Ukr9ZB67GaijlHLRWl/E+DH7RyBDKbXM/CEPxv9z7xbo8D6D8d1Y+OLANZ8DEUqpJhg/8g9prRPMtPJeLMo0n5dLaXUrkK20C0dWm5ltkVnesiugGfB8oYsH3mb5N3LxCvN4K7/Z8ZJKye9ReY/bhDGaJNx8vBGjc6e7+fxavToVqtdQoODizyVdULl2vBvG5+7a8R9hjOS5pvBFILTWZV4YA/6NMSpltVLqiFJqknlseS/UlKddS/pcFVv2DajIhbHHCr0fYRjLINzo33lJ72NDjNFzuwocv9LcDze/LcRNIB084q6mlKqtlHoQYz70F1rrfRjDHDXGfG+UUiMxRnxccwJjCOs1ZeUHGKeU8lJK1cMYMTC3rGOVUq2UUj2VUlUxOmguY1yZ2A6cV8ZisNWVUi5KqTZmJ1URWutfMNYc+UA |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, good to see some pointers on how these infilling options are best used.
OK, I've responded to all of @jkikstra 's points other than splitting the notebook up. Is that something that would be helpful? It's quite a short section, but it is logically separate. @znicholls was suggesting that each cruncher has a separate notebook, don't know if this is just annoying to look through though. |
In general I prefer shorter notebooks with one clear topic over longer ones, mostly because of the added benefit that it is easier the find what you're looking for when you're browsing the directory. |
OK, I'll do a separate PR where I split the notebooks up into smaller, numbered chapters. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concerning the notebooks this looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -40,14 +46,26 @@ Silicone is free software under a BSD 3-Clause License, see `LICENSE <https://gi | |||
Installation | |||
------------ | |||
|
|||
Instructions to be written. | |||
This Python package can be installed directly from github. The release version is hosted at |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's skype about this. Best practice is to release like is done for scmdata.
That means users can then install simply by doing pip install silicone
or conda install silicone
. If they want a specific version, they can specify e.g. pip install silicone==0.2.1
. With releases on pypi (pip) and conda, we don't have to worry about a 'release version' and a 'development version'. I would suggest we simply do away with the znicholls/silicone (when you're ready) and move it all to GranthamImperial.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems like a good idea, but to be done in a separate pull request. Currently what's written there is true, so I'm inclined to stick with that and update it later.
Rewording of readme from review Co-Authored-By: Zeb Nicholls <zebedee.nicholls@climate-energy-college.org>
Pull request
Please confirm that this pull request has done the following:
CHANGELOG.rst
addedAdding to CHANGELOG.rst
Please add a single line in the changelog notes similar to one of the following: