search

ArcticSnow / TopoPyScale

TopoPyScale: a Python library to perform simplistic climate downscaling at the hillslope scale
https://topopyscale.readthedocs.io
MIT License
42 stars 10 forks source link

update Doc when adding config options #82

Closed ArcticSnow closed 1 year ago

ArcticSnow commented 1 year ago

@joelfiddes @paswyss , I see in your latest commits that you've added neat config options climate.path and realtime. I suspect you have more in mind. Can you, when adding options, update the documentation page about config. There is both an example of the yml file and a table listing the options of each configuration.

That we may not loose track of what is available.

Very much appreciated! :)

joelfiddes commented 1 year ago

guilty as charged! Need to define a new feature work flow (im not tooo good at this) based on new branches.

Also I have been thinking a config generator tool would be useful as it gets more complex. We have the same issue in snowpack and meteio also with dependencies between config items. Recently this was developed to solve this:

https://inishell.slf.ch/

Something like that would be amazing as missing/ old configs items by recycling old config files has probably cost SLF (and other?) researchers years of cumulative hair-pulling time! I dont have much left thats for sure......

paswyss commented 1 year ago

Yes, I am guilty too! Of course, I will update that :) (I did another change just now). I will update the docs in the next days.

joelfiddes commented 1 year ago

@paswyss i think you did the same edit as me - great minds think alike! When i went to commit my new climate path variable found you already implemented :)

For me this was key to run on a SLURM based cluster where I need to distribute simulations by time in a more embarrassingly parallel sense than the dask based approach, i describe it here:

https://github.com/ArcticSnow/TopoPyScale/discussions/83#discussion-5231360

paswyss commented 1 year ago

@ArcticSnow I updated the docs on my local clone. But I do not have push access to the documentation repository. Can you grant it to me?

@joelfiddes Indeed! Funny that it was the same timing! I just wrote you an email with two brief questions concerning the downscaling.

ArcticSnow commented 1 year ago

@paswyss Added as contributor!

ArcticSnow commented 1 year ago

Thank you @paswyss for the updates !! :)