search

GalSim-developers / GalSim

The modular galaxy image simulation toolkit. Documentation:
http://galsim-developers.github.io/GalSim/
Other
227 stars 107 forks source link

How to find the file named 'Quick Reference Guide'? #1114

Closed xxhustc closed 3 years ago

rmandelb commented 3 years ago

We phased out the Quick Reference Guide at some point in the past few years. You should instead use the GalSim documentation that lives here: http://galsim-developers.github.io/GalSim/

Is there somewhere in this repo that still refers to the Quick Reference Guide? If so, we should fix that.

rmandelb commented 3 years ago

Answered my question myself: the wiki still refers to it in a few places, with broken links - may need some other cleanup as well. I'm happy to take this on in the next couple of days.

xxhustc commented 3 years ago

Thank you very much for answering my question. I read Rowe's paper “ GALSIM:modular galaxy Image simulation toolkit“ to learn about the quick reference guide. If the content of the paper can not be modified, you can indicate the new link next to the old link. This is just my personal suggestion. I hope it can help you. Thanks again！

------------------ 原始邮件 ------------------ 发件人: "GalSim-developers/GalSim" <notifications@github.com>; 发送时间: 2021年2月3日(星期三) 晚上8:55 收件人: "GalSim-developers/GalSim"<GalSim@noreply.github.com>; 抄送: "徐小慧"<3491925801@qq.com>;"Author"<author@noreply.github.com>; 主题: Re: [GalSim-developers/GalSim] How to find the file named 'Quick Reference Guide'? (#1114)

We phased out the Quick Reference Guide at some point in the past few years. You should instead use the GalSim documentation that lives here: http://galsim-developers.github.io/GalSim/

Is there somewhere in this repo that still refers to the Quick Reference Guide? If so, we should fix that.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

rmandelb commented 3 years ago

Thanks! I think it's important to remember that that paper describes a specific GalSim version. Many aspects of GalSim have evolved since then (features, code structure, installation processes, etc.), not just the documentation. We have not been updating the paper to describe GalSim evolution since the paper was published, which would be a massive undertaking -- rather, up-to-date documentation describing current GalSim features and documentation can be found here. I hope that helps!

rmandelb commented 3 years ago

Updated wiki to remove pointers to the quick reference guide. Closing #1114.