search

leap-stc / ClimSim

An open large-scale dataset for training high-resolution physics emulators in hybrid multi-scale climate simulators.
https://leap-stc.github.io/ClimSim/
Apache License 2.0
138 stars 40 forks source link

Add project structure diagram #57

Closed NoraLoose closed 1 year ago

NoraLoose commented 1 year ago

As discussed here, this adds a file ARCHITECTURE.md to the repo root.

Closes #23.

NoraLoose commented 1 year ago

Thanks for the review @cisaacstern!

Only thing aside from the inline edits is maybe we want to mention this in README or website somewhere?

Good point, I made a suggestion via the latest commit. What do you think?

NoraLoose commented 1 year ago

@cisaacstern just pinging you to see what you think about the last commit. No rush, though!

cisaacstern commented 1 year ago

@NoraLoose thanks for the reminder, and sorry for the delay.

Yes, basically I think that looks good, my only question is can we get a GitHub link in the top nav of the website? Like:

Screen Shot 2023-08-22 at 4 21 43 PM

My concern with the code repo link being pushed deeper into the docs is that there is not am easily discoverable link back from the website to the GitHub repo.

NoraLoose commented 1 year ago

The repo button at the top is a good idea. (I am just realizing how much I am missing such a button on another project website that I'm managing!) Added via the latest commit.

cisaacstern commented 1 year ago

Awesome then IMO this is good to go! Thanks @NoraLoose !!