Skip to content
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

Add overview of different softwares to User Guide #800

Closed
sarah-hlsn opened this issue Oct 31, 2023 · 6 comments
Closed

Add overview of different softwares to User Guide #800

sarah-hlsn opened this issue Oct 31, 2023 · 6 comments
Assignees

Comments

@sarah-hlsn
Copy link
Collaborator

Adapt Climada user & developer guides to include comprehensive overview of different tools and their uses.

@chahank
Copy link
Member

chahank commented Oct 31, 2023

Thanks for opening this issue! Here is also a summary of other small points we discussed that could be used to improve the developer guides. If you happen to be able to tackle any other of these topics at the same time, please feel free to do so.

  • Remove installation instruction duplicate
  • Reviewer Guide: move it into a separate file
  • Tutorial Guide: the example climada_hazard_TropCyclone is not ideal, replace.
  • Testing and CI: not clear enough: file structure, CI. Add unittests files are in this folder:, ...integration tests are in that folder: ...
  • Testing and CI: change the instructions about how to run tests (not make, use your IDE, or wait for GitHub actions)
  • Move exception handling and logging to a separate guide
  • move the "does it belong into CLIMADA" somewhere else
  • remove Impf_ If_ section

@sarah-hlsn
Copy link
Collaborator Author

* Tutorial Guide: the example `climada_hazard_TropCyclone` is not ideal, replace.

What exactly do you mean here? Are you referring to this being mentioned in the "CLIMADA Tutorial Template" of the Developer Guide or are you referring to the tutorial itself, or something else?

@chahank
Copy link
Member

chahank commented Nov 1, 2023

In the tutorial guide, I think that the climada_hazard_TropCyclone is cited as the tutorial to follow. We probably should change that to one of the well done tutorials of the core modules instead.

@sarah-hlsn
Copy link
Collaborator Author

actually climada_hazard_TropCyclone.ipynb is only mentioned as an example for the naming convention, the tutorials recommend as good examples are the Exposure and Hazard tutorials, so I would not change anything there.

@peanutfun
Copy link
Member

@sarah-hlsn Could you quickly go through the list above and check if all is resolved by #808? If yes, we can close with issue

@sarah-hlsn
Copy link
Collaborator Author

@peanutfun Yes, everything is resolved, will close now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

3 participants