Implement of documentation #61
Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Amazing @Margherita-Capitani :D
I see this PR builds on top of the previous PR, so priority is merging the otherone.
I've added a couple of comments and great!
Out of curiosity, have you used ChatGPT for revising the documentation?
| countries: ["NG"] | ||
|
|
||
|
|
||
| Please remember,before proceeding, that as has already been mentioned, in case you are running a simulation in tutorial mode you will only be able to select one nation from NG,BJ,BW or MA; |
There was a problem hiding this comment.
check the spacing.
Moreover, for improving the styling, I'd recommend to do:
pre-commit install
pre-commit run --all
The code will change the styling of files and some grammar things.
For example, here the spacing here. In the text here, we can use the full names Nigeria, Benin etc
There was a problem hiding this comment.
Perfect, yes sorry i always forget of the pre-commit! One question: but after i do pre-commit run --all it fix all of this type of error automatically?
| Configure `coordinates` | ||
| -------------------------- | ||
| Currently, the tool allows us to select the coverage area of interest by going to enter the coordinates of the vertices of the rectangular surface we want to be covered. | ||
| At the end of the config.yaml file you will find the microgrid list section where you can go to enter the coordinates. |
There was a problem hiding this comment.
mention the microgrig_list parameter using the ` character so that it will be highlighted in the text
|
|
||
| Regarding topics in the enable section: | ||
|
|
||
| - Retrive_databundle and retrive_cost_data: After the initial run, it is a good idea to set retrive databundle and cost data to false to avoid re-downloading unnecessary data. |
There was a problem hiding this comment.
when referencing option names e.g. "retrieve_databundle", it would be great to surround them with the characters to improve the styiling, such asretrieve_databundle`
| In in the configuration file you will also find the variable "year" this specifies the reference year for the local population data. | ||
| It is your choice whether or not to keep the data temporally concordant | ||
|
|
||
| specify the method of load calculation : |
There was a problem hiding this comment.
First letter uppercase and avoid the spacing at the end "calculation :" -> "calculation:"
There was a problem hiding this comment.
We try to avoid adding binaries to the repo as they increase the size of the overall github repo.
There are special exception and this may be one, but this file seems a bit large.
A proposal is to remove this from github history and potentially load a smaller file as the procedure is complete.
It would be advisable to resize this file around 100kb or so [currently it is 1.4Mb]
Luckily, images have been added only recently and so the fix can be done by:
[DANGER: this is going to overwrite the github history and you may lose local changes as well as some implemented changes; it is recommended to create a copy of the folder first]
git reset 62b32af --hard
That line restores the github history to that commit.
After that commit, there are only 2 commits to be re-implemented:
- 3822899
- c78a7df [to do this one, you can do pre-commit run --all before pushing the changes of the previous commit and commit the changes that the pre-commit proposes]
Happy to support
Perfect, yes I had noticed that I had made some mistakes in opening the PR, I replied to the comments in the other PR and it should be ready for the Merge :D |
|
Merged :D great contribution! :) |
First proposal to improve the documentation. An explanation is added on the tutorial, and the basic configuration in the configuration file. The next step would be to explain how to run the code in the ‘non-tutorial’ case.
I am not sure if I have inserted the images correctly.