Hi,
I finally got some time to update the sphinx documentation. The final result is at [1] and the git repo can be cloned from [2]. Basically, so far I've just pulled stuff from the google pages and converted into sphinx format and did some polishing. I think it's a good start, but definitely needs more work! For example, the tutorial right now is more "theoretical", and may not be "practical" enough for a new user to understand...probably this can be separated into a simpler tutorial and then an advanced tutorial or reference section, especially the problem description format.
Also, I haven't had time to look into genDocs.py yet...
Thanks! Logan
[1] http://logansorenson.github.com/sfepy_doc2 [2] git://github.com/logansorenson/sfepy_doc2.git
Hi Logan,
Logan Sorenson wrote:
Hi,
I finally got some time to update the sphinx documentation. The final result is at [1] and the git repo can be cloned from [2]. Basically, so far I've just pulled stuff from the google pages and converted into sphinx format and did some polishing. I think it's a good start, but definitely needs more work! For example, the tutorial right now is more "theoretical", and may not be "practical" enough for a new user to understand...probably this can be separated into a simpler tutorial and then an advanced tutorial or reference section, especially the problem description format.
Awesome, it looks great! The LaTeX stuff is rendered very nice, cool. And I have learnt how to define the LaTeX preamble in doc/conf.py, thanks a lot.
I agree that the tutorial, as it is, is not too useful for actually starting to use sfepy in terms of defining your own problems. (But it looks great!).
To improve this, I would start by rstifying one or both of the commented input files: input/poisson.py (scalar problem), and input/linear_elastic.py (vector field problem). What do you think? This could be complemented by a more theoretical info about FEM. A link to [3] might do as well for the moment, IMHO.
Also, I haven't had time to look into genDocs.py yet...
No problem. Me neither, I am swamped with stuff due to the end of this month. (Today is a public holiday here, nobody normal works...)
Thanks for your help! r.
[1] http://logansorenson.github.com/sfepy_doc2 [2] git://github.com/logansorenson/sfepy_doc2.git [3] http://en.wikipedia.org/wiki/Finite_element_method
Hi Robert,
On Wed, Oct 28, 2009 at 3:55 AM, Robert Cimrman <cimr...@ntc.zcu.cz> wrote:
Hi Logan,
Logan Sorenson wrote:
Hi,
I finally got some time to update the sphinx documentation. The final result is at [1] and the git repo can be cloned from [2]. Basically, so far I've just pulled stuff from the google pages and converted into sphinx format and did some polishing. I think it's a good start, but definitely needs more work! For example, the tutorial right now is more "theoretical", and may not be "practical" enough for a new user to understand...probably this can be separated into a simpler tutorial and then an advanced tutorial or reference section, especially the problem description format.
Awesome, it looks great! The LaTeX stuff is rendered very nice, cool. And I have learnt how to define the LaTeX preamble in doc/conf.py, thanks a lot.
I agree that the tutorial, as it is, is not too useful for actually starting to use sfepy in terms of defining your own problems. (But it looks great!).
To improve this, I would start by rstifying one or both of the commented input files: input/poisson.py (scalar problem), and input/linear_elastic.py (vector field problem). What do you think? This could be complemented by a more theoretical info about FEM. A link to [3] might do as well for the moment, IMHO.
Ok, this makes a lot more sense to me from a new user perspective. But I don't think my efforts have been in vain, since as you mentioned, the docs look great (thanks mostly to sphinx of course :) )! So I think I'll take what I currently have as the starting point for the user guide and instead write a new tutorial based off the commented input files.
Also, I haven't had time to look into genDocs.py yet...
No problem. Me neither, I am swamped with stuff due to the end of this month. (Today is a public holiday here, nobody normal works...)
It seems that there never is enough time for everything we want to do...good luck with your deadlines!
Thanks for your help! r.
[1] http://logansorenson.github.com/sfepy_doc2 [2] git://github.com/logansorenson/sfepy_doc2.git [3] http://en.wikipedia.org/wiki/Finite_element_method
Logan
Hi Logan,
Logan Sorenson wrote:
Hi Robert,
On Wed, Oct 28, 2009 at 3:55 AM, Robert Cimrman <cimr...@ntc.zcu.cz> wrote:
Hi Logan,
Logan Sorenson wrote:
Hi,
I finally got some time to update the sphinx documentation. The final result is at [1] and the git repo can be cloned from [2]. Basically, so far I've just pulled stuff from the google pages and converted into sphinx format and did some polishing. I think it's a good start, but definitely needs more work! For example, the tutorial right now is more "theoretical", and may not be "practical" enough for a new user to understand...probably this can be separated into a simpler tutorial and then an advanced tutorial or reference section, especially the problem description format. Awesome, it looks great! The LaTeX stuff is rendered very nice, cool. And I have learnt how to define the LaTeX preamble in doc/conf.py, thanks a lot.
I agree that the tutorial, as it is, is not too useful for actually starting to use sfepy in terms of defining your own problems. (But it looks great!).
To improve this, I would start by rstifying one or both of the commented input files: input/poisson.py (scalar problem), and input/linear_elastic.py (vector field problem). What do you think? This could be complemented by a more theoretical info about FEM. A link to [3] might do as well for the moment, IMHO.
Ok, this makes a lot more sense to me from a new user perspective. But I don't think my efforts have been in vain, since as you mentioned, the docs look great (thanks mostly to sphinx of course :) )! So I think I'll take what I currently have as the starting point for the user guide and instead write a new tutorial based off the commented input files.
Of course it was not in vain, it was not meant that way by no means! :) You are right - as it is, parts of the tutorial (the special applications(?), not-so-used scripts, problem description file elements) belong more to the user guide. Other parts, describing the main executable scripts (runTests.py, simple.py, postproc.py, isfepy), should stay in the tutorial.
There are also quite useful scripts related to meshes not described at all: # mesh generation script/blockgen.py script/cylindergen.py # convert mesh between formats and possible rescale script/convert_mesh.py script/mesh_to_vtk.py # should be merged with the above, preserves groups
They should be mentioned somewhere.
Also, I haven't had time to look into genDocs.py yet... No problem. Me neither, I am swamped with stuff due to the end of this month. (Today is a public holiday here, nobody normal works...)
It seems that there never is enough time for everything we want to do...good luck with your deadlines!
Thanks! As they approach, a strange calm is setting in my mind... ;)
cheers, r.
[1] http://logansorenson.github.com/sfepy_doc2 [2] git://github.com/logansorenson/sfepy_doc2.git [3] http://en.wikipedia.org/wiki/Finite_element_method
Hi,
I made a quick tutorial based off input/poisson.py. Please see [1] and [2]. Hopefully it's more beginner friendly :). Probably it needs a lot of editing/additions but at least it's a start.
I also moved the old tutorial as the basis for the user's guide. I think this is a good place to mention the as yet undocumented scripts Robert has suggested below. I'll try to get some basic description of these as time permits.
Thanks! Logan
On Thu, Oct 29, 2009 at 2:03 AM, Robert Cimrman <cimr...@ntc.zcu.cz> wrote:
Hi Logan,
Logan Sorenson wrote:
Hi Robert,
On Wed, Oct 28, 2009 at 3:55 AM, Robert Cimrman <cimr...@ntc.zcu.cz> wrote:
Hi Logan,
Logan Sorenson wrote:
Hi,
I finally got some time to update the sphinx documentation. The final result is at [1] and the git repo can be cloned from [2]. Basically, so far I've just pulled stuff from the google pages and converted into sphinx format and did some polishing. I think it's a good start, but definitely needs more work! For example, the tutorial right now is more "theoretical", and may not be "practical" enough for a new user to understand...probably this can be separated into a simpler tutorial and then an advanced tutorial or reference section, especially the problem description format. Awesome, it looks great! The LaTeX stuff is rendered very nice, cool. And I have learnt how to define the LaTeX preamble in doc/conf.py, thanks a lot.
I agree that the tutorial, as it is, is not too useful for actually starting to use sfepy in terms of defining your own problems. (But it looks great!).
To improve this, I would start by rstifying one or both of the commented input files: input/poisson.py (scalar problem), and input/linear_elastic.py (vector field problem). What do you think? This could be complemented by a more theoretical info about FEM. A link to [3] might do as well for the moment, IMHO.
Ok, this makes a lot more sense to me from a new user perspective. But I don't think my efforts have been in vain, since as you mentioned, the docs look great (thanks mostly to sphinx of course :) )! So I think I'll take what I currently have as the starting point for the user guide and instead write a new tutorial based off the commented input files.
Of course it was not in vain, it was not meant that way by no means! :) You are right - as it is, parts of the tutorial (the special applications(?), not-so-used scripts, problem description file elements) belong more to the user guide. Other parts, describing the main executable scripts (runTests.py, simple.py, postproc.py, isfepy), should stay in the tutorial.
There are also quite useful scripts related to meshes not described at all: # mesh generation script/blockgen.py script/cylindergen.py # convert mesh between formats and possible rescale script/convert_mesh.py script/mesh_to_vtk.py # should be merged with the above, preserves groups
They should be mentioned somewhere.
Also, I haven't had time to look into genDocs.py yet... No problem. Me neither, I am swamped with stuff due to the end of this month. (Today is a public holiday here, nobody normal works...)
It seems that there never is enough time for everything we want to do...good luck with your deadlines!
Thanks! As they approach, a strange calm is setting in my mind... ;)
cheers, r.
[1] http://logansorenson.github.com/sfepy_doc2 [2] git://github.com/logansorenson/sfepy_doc2.git [3] http://en.wikipedia.org/wiki/Finite_element_method
Logan Sorenson wrote:
Hi,
I made a quick tutorial based off input/poisson.py. Please see [1] and [2]. Hopefully it's more beginner friendly :). Probably it needs a lot of editing/additions but at least it's a start.
Yes, it is a good start, thanks! BTW. the weird comments in input/poisson.py were meant to be processed by pyreport [4] - it worked quite a long time ago, not sure about its current status.
I also moved the old tutorial as the basis for the user's guide. I think this is a good place to mention the as yet undocumented scripts Robert has suggested below. I'll try to get some basic description of these as time permits.
That would be great! Anyway, it is shaping pretty well :)
Thank you for your great documentation effort! r.
[1] http://logansorenson.github.com/sfepy_doc2 [2] git://github.com/logansorenson/sfepy_doc2.git [3] http://en.wikipedia.org/wiki/Finite_element_method [4] http://gael-varoquaux.info/computers/pyreport/
Hi Robert,
On Wed, Nov 4, 2009 at 10:22 AM, Robert Cimrman <cimr...@ntc.zcu.cz> wrote:
Logan Sorenson wrote:
Hi,
I made a quick tutorial based off input/poisson.py. Please see [1] and [2]. Hopefully it's more beginner friendly :). Probably it needs a lot of editing/additions but at least it's a start.
Yes, it is a good start, thanks! BTW. the weird comments in input/poisson.py were meant to be processed by pyreport [4] - it worked quite a long time ago, not sure about its current status.
Yeah, I wasn't really sure what to do with those comments because they are quite informative, but don't mix well with sphinx yet...hence the strange mix of formatting between sphinx and comments. :) Would it be better to translate them into pure sphinx? I'm not sure yet how this will work, but I'll search around for some examples.
I also moved the old tutorial as the basis for the user's guide. I think this is a good place to mention the as yet undocumented scripts Robert has suggested below. I'll try to get some basic description of these as time permits.
That would be great! Anyway, it is shaping pretty well :)
Thank you for your great documentation effort! r.
You're welcome! Logan
[1] http://logansorenson.github.com/sfepy_doc2 [2] git://github.com/logansorenson/sfepy_doc2.git [3] http://en.wikipedia.org/wiki/Finite_element_method [4] http://gael-varoquaux.info/computers/pyreport/
Logan Sorenson wrote:
Hi Robert,
On Wed, Nov 4, 2009 at 10:22 AM, Robert Cimrman <cimr...@ntc.zcu.cz> wrote:
Logan Sorenson wrote:
Hi,
I made a quick tutorial based off input/poisson.py. Please see [1] and [2]. Hopefully it's more beginner friendly :). Probably it needs a lot of editing/additions but at least it's a start. Yes, it is a good start, thanks! BTW. the weird comments in input/poisson.py were meant to be processed by pyreport [4] - it worked quite a long time ago, not sure about its current status.
Yeah, I wasn't really sure what to do with those comments because they are quite informative, but don't mix well with sphinx yet...hence the strange mix of formatting between sphinx and comments. :) Would it be better to translate them into pure sphinx? I'm not sure yet how this will work, but I'll search around for some examples.
I guess having the text in pure sphinx would be better. The last pyreport version (0.3.4a) does not work with it for me anyway. The input file can stay as it is.
cheers, r.
> [1] http://logansorenson.github.com/sfepy_doc2 > [2] git://github.com/logansorenson/sfepy_doc2.git [3] http://en.wikipedia.org/wiki/Finite_element_method [4] http://gael-varoquaux.info/computers/pyreport/
participants (2)
-
Logan Sorenson -
Robert Cimrman