search

os-climate / witness-core

Evaluate climate change impact
Apache License 2.0
12 stars 12 forks source link

documentation: Add how_to_model_a_study.md #1

Closed kmarinushkin closed 2 years ago

kmarinushkin commented 2 years ago

Quick start guide to modelling in witness-core

Signed-off-by: Kirill Marinushkin k.marinushkin@gmail.com

MichaelTiemannOSC commented 2 years ago

Kirill, thank you for taking this initiative!

I have one question, which is about .puml files. Elsewhere in the project I have introduced mermaid: https://github.com/os-climate/ITR/blob/main/docs/Calculation.md. I'm not saying that mermaid is better than puml, but if we are going to create diagrams, I suggest we try to do so with a common approach. If .puml is better than mermaid for this and other use cases, I'll be happy to change my docs to use better a better diagraming language/approach.

kmarinushkin commented 2 years ago

Thanks, @MichaelTiemannOSC :)

this initiative is actually proposed by @sostrades-matthieu-meaux, as a first step for me, to join witness-core development.

suggest we try to do so with a common approach

i fully agree, I am always in favour of common style in projects. I just didn't know, that some common style for diagrams already exists. Sure, I will switch my diagrams to mermaid.

If .puml is better than mermaid for this and other use cases

I have an impression, that mermaid will do the job, but I need to try it first. .puml stands for PlantUML, a tool for UML diagrams, if you are interested to have a look. What makes mermaid interesting for me - is that GitHub seems to support it natively. My diagrams I needed to convert to .svg images, to insert them into documentation.

Even if capabilities of mermaid are not as rich as of PlantUML - it could be enough, for our purpose. I will give it a try.

kmarinushkin commented 2 years ago

Thanks for the proposal, @MichaelTiemannOSC!

I pushed mermaid diagrams - they look clear to understand, for the documentation purpose, and simplify the way it's stored in the repo!

kmarinushkin commented 2 years ago

Hello @sostrades-tchevalier,

Since you approved the PR, may I ask you to merge it? I don't have such permissions in this repo, and I have no feedback from Matthieu.

I don't like long hanging PRs, and would prefer to merge it or cancel it sooner then later

sostrades-tchevalier commented 2 years ago

Hi Kirill,

Thanks for the head up and sorry for the delay, we’re still half way from our legacy internal DevOps to the public one !

We will process that quickly 😊

Best regards,

Thierry

From: Kirill Marinushkin @.> Sent: 13 October 2022 09:34 To: os-climate/witness-core @.> Cc: Thierry Chevalier @.>; Mention @.> Subject: Re: [os-climate/witness-core] documentation: Add how_to_model_a_study.md (PR #1)

Hello @sostrades-tchevalier https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsostrades-tchevalier&data=05%7C01%7C%7Ca35601be89ab4e96ed3208daaced5e5e%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638012432731938335%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=PKUWa6hnfM3Kv7Igm9Kr%2F9YCEfGFfv60hYTSt1%2FkwSg%3D&reserved=0 ,

Since you approved the PR, may I ask you to merge it? I don't have such permissions in this repo, and I have no feedback from Matthieu.

I don't like long hanging PRs, and would prefer to merge it or cancel it sooner then later

— Reply to this email directly, view it on GitHub https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fos-climate%2Fwitness-core%2Fpull%2F1%23issuecomment-1277161720&data=05%7C01%7C%7Ca35601be89ab4e96ed3208daaced5e5e%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638012432731938335%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=w60H1P3JuuP3C%2BAaERlU%2F2GpgP16nD11fFcuAveCMVY%3D&reserved=0 , or unsubscribe https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAXHREL3GRYQEHCOUQB3DB23WC63QLANCNFSM56RHOHFA&data=05%7C01%7C%7Ca35601be89ab4e96ed3208daaced5e5e%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C638012432731938335%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=TVa09VTQUsBBvi8pLR41DUxjkQy3xlVIMrCHUiuB9qA%3D&reserved=0 . You are receiving this because you were mentioned. https://github.com/notifications/beacon/AXHREL33JSYRFZJKRVEJXWLWC63QLA5CNFSM56RHOHFKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOJQP7B6A.gif Message ID: @. @.> >