search

thegooglecodearchive / sfepy

Automatically exported from code.google.com/p/sfepy
0 stars 0 forks source link

user's guide #22

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
I believe we need a user's guide. Same rationale as here:

http://code.google.com/p/sympy/issues/detail?id=717

Sample pages are here:

http://sympy.googlecode.com/svn/materials/usersguide/guide.html

This is a long term issue, I don't think we should work on this right now.
But in the horizon of a few months, we should fix this.

Original issue reported on code.google.com by ondrej.c...@gmail.com on 18 Feb 2008 at 12:39

GoogleCodeExporter commented 9 years ago 
Yes. I have looked at the sympy guide - it looks very nice. By the time we get 
to
this the right tools to write the docs with should be settled. I hate editing 
xml, so
we should keep an eye on alternatives.

Original comment by robert.c...@gmail.com on 18 Feb 2008 at 12:47

GoogleCodeExporter commented 9 years ago 
Agree. We should use tools that people use though. And important here is how it 
looks
like.

Original comment by ondrej.c...@gmail.com on 18 Feb 2008 at 12:51

GoogleCodeExporter commented 9 years ago 
I suggest to write our userguide in rst. The same way as in sympy, ipython and 
others. 

Also, there should be a chapter "how to learn FEM", with the points made in:

http://groups.google.com/group/sfepy-devel/browse_thread/thread/2dc74465058fe558
/

This is imho quite a high priority. Once we have all the tools for producing
documentation ready, we'll simply add a section whenever we implement 
something, and
that's it.

Original comment by ondrej.c...@gmail.com on 3 Mar 2008 at 2:16

GoogleCodeExporter commented 9 years ago 
I am fine with rst. Do you have some details regarding how the groups you 
listed use
it? Yes, it is a high priority task.

Original comment by robert.c...@gmail.com on 3 Mar 2008 at 3:02

GoogleCodeExporter commented 9 years ago 
Well, they are just starting. For example yesterday I wrote a pdf generation 
code for
ipython1. Well, we just go ahead, write it in rst, and maybe run it throug rst 
-> xml
-> prettydoc

Original comment by ondrej.c...@gmail.com on 3 Mar 2008 at 4:00

GoogleCodeExporter commented 9 years ago 
The documentation is now at [1], and is based on sphinx. It's work in progress 
still...

[1] http://docs.sfepy.org/doc/

Original comment by robert.c...@gmail.com on 24 Nov 2009 at 1:38

GoogleCodeExporter commented 9 years ago 
On ubuntu the installation requirements should include python-dev (Header files 
and a
static library for Python), which is not installed by default.

Original comment by freevryh...@gmail.com on 12 Apr 2010 at 11:59

GoogleCodeExporter commented 9 years ago 
Installation: setuptools also required

Original comment by freevryh...@gmail.com on 13 Apr 2010 at 12:03

GoogleCodeExporter commented 9 years ago 
Installation: gfortran also required

Original comment by freevryh...@gmail.com on 13 Apr 2010 at 12:06

GoogleCodeExporter commented 9 years ago 
OK, I will add those to the installation docs. Do you know why gfortran is 
needed? We
have no fortran dependency...

Original comment by robert.c...@gmail.com on 13 Apr 2010 at 7:07

GoogleCodeExporter commented 9 years ago 
hmm - not sure why gfortran was needed? BLAS perhaps? Please disregard. Found a 
spello.

Original comment by freevryh...@gmail.com on 17 Jun 2010 at 1:43

Attachments:

GoogleCodeExporter commented 9 years ago 
Thanks, applied!

Original comment by robert.c...@gmail.com on 21 Jun 2010 at 8:39

GoogleCodeExporter commented 9 years ago 
Migrated to http://github.com/sfepy/sfepy/issues/26

Original comment by robert.c...@gmail.com on 30 Jan 2012 at 10:24