search

WarwickMicroscopy / Felix

Felix: Bloch wave method diffraction pattern simulation software
16 stars 10 forks source link

A Manual #39

Open kidwhizz opened 10 years ago

kidwhizz commented 10 years ago

Felix needs a full manual, explaining every inch of the code, how to setup the input files and how to interpret the output

kidwhizz commented 9 years ago

Id suggest when the manual is written, that the equations are labelled like they would be in a paper and then we reference the equations within the code. That way a new user/developer can easily understand the code by referring to the manual

RudoRoemer commented 9 years ago

I'd suggest not to use numbers but labels. That should make changes easier.

-----Original Message----- From: "kidwhizz" notifications@github.com Sent: ‎10/‎12/‎2014 14:55 To: "RudoRoemer/Felix" Felix@noreply.github.com Subject: Re: [Felix] A Manual (#39)

Id suggest when the manual is written, that the equations are labelled like they would be in a paper and then we reference the equations within the code. That way a new user/developer can easily understand the code by referring to the manual — Reply to this email directly or view it on GitHub.

JacobJoseph-gu commented 7 years ago

We have now implemented Doxygen. The html it produces is in felix under docs/doxygen/html/. Unfortunately we can't directly view it from github website, but uploading and viewing that html is something we can look into.

It includes depedency flow charts as well as simple descriptions and authors for each procedure and module directly from the code. I will fill in the descriptions some more. For a procedure, I can add a summary description, the associated physics formulas and also the key felix variables. Using doxygen-recognisable comments throughout is something we can add and work upon.

Our github wiki is clear and has good information: https://github.com/RudoRoemer/Felix/wiki/Quick-User-Guide We probably want all of the felix.inp docuementation in a read_inp MODULE in felix and then doxygen can read it.

Presumably most documentation should be in the source code and doxygen-recognisable. We could use the doxygen html and or here on the github website to store download and package information.

rbeanland commented 7 years ago

The quick user guide needs updating as some parts are now incorrect.

Richard

On 12 Aug 2017, at 13:19, JacobJoseph-gu notifications@github.com<mailto:notifications@github.com> wrote:

We have now implemented Doxygen. The html it produces is in felix under docs/doxygen/html/. Unfortunately we can't directly view it from github website, but uploading and viewing that html is something we can look into.

It includes depedency flow charts as well as simple descriptions and authors for each procedure and module directly from the code. I will fill in the descriptions some more. For a procedure, I can add a summary description, the associated physics formulas and also the key felix variables. Using doxygen-recognisable comments throughout is something we can add and work upon.

Our github wiki is clear and has good information: https://github.com/RudoRoemer/Felix/wiki/Quick-User-Guide We probably want all of the felix.inp docuementation in a read_inp MODULE in felix and then doxygen can read it.

Presumably most documentation should be in the source code and doxygen-recognisable. We could use the doxygen html and or here on the github website to store download and package information.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/RudoRoemer/Felix/issues/39#issuecomment-321977670, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AHzOubxvMy5DQi6AxLl-f9aRIl3GKjQ9ks5sXZhJgaJpZM4Cm4D8.