gsl-shell.git - gsl-shell

index : gsl-shell.git
gsl-shell
summary refs log tree commit diff
diff options
context:
space:
mode:
authorFrancesco Abbate <francesco.bbt@gmail.com>2011年10月28日 15:19:52 +0200
committerFrancesco Abbate <francesco.bbt@gmail.com>2011年10月28日 15:19:52 +0200
commit108005cc507a81c8fc155ab24c3e87fd3e6e14f7 (patch)
tree7f443ef522c49a897b8e5804c43a28720d12ccfb
parent485292c127db59762d50ae333270a8ad1ea32c3f (diff)
downloadgsl-shell-108005cc507a81c8fc155ab24c3e87fd3e6e14f7.tar.gz
Documentation update for the 2.0 beta release
Diffstat
-rw-r--r--demos/fractals.lua 3
-rw-r--r--doc/gsl-shell-index/Makefile 1
-rw-r--r--doc/gsl-shell-index/acknowledgments.rst 12
-rw-r--r--doc/gsl-shell-index/conf.py 3
-rw-r--r--doc/gsl-shell-index/index.rst 54
-rw-r--r--doc/gsl-shell-index/older-news.rst (renamed from doc/gsl-shell-index/news.rst)8
-rw-r--r--doc/gsl-shell-index/why-donate.rst 2
-rw-r--r--doc/user-manual/Makefile 1
-rw-r--r--doc/user-manual/conf.py 5
-rw-r--r--doc/user-manual/index.rst 2
-rw-r--r--doc/user-manual/intro.rst 2
-rw-r--r--doc/user-manual/randist.rst 2
12 files changed, 57 insertions, 38 deletions
diff --git a/demos/fractals.lua b/demos/fractals.lua
index 84ceb3c1..d6c8d0cf 100644
--- a/demos/fractals.lua
+++ b/demos/fractals.lua
@@ -12,8 +12,6 @@ local function c_generator(n, n_angle, len_frac, g)
local sh = ilist(|k| g[(k-1)%r+1] - g[(k-2)%r+1], r)
local a = (g[1]*n) % n_angle
- print('sh', sh)
-
local z = 0
return function()
if w[n+1] == 0 then
@@ -21,7 +19,6 @@ local function c_generator(n, n_angle, len_frac, g)
z = z + sz[a+1]
for j=1,n+1 do
w[j] = (w[j] + 1) % r
- print(j, w[j], sh[w[j]+1], a)
a = (a + sh[w[j]+1]) % n_angle
if w[j] ~= 0 then
break
diff --git a/doc/gsl-shell-index/Makefile b/doc/gsl-shell-index/Makefile
index 857a21a7..9dc8a958 100644
--- a/doc/gsl-shell-index/Makefile
+++ b/doc/gsl-shell-index/Makefile
@@ -38,7 +38,6 @@ clean:
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- cp $(BUILDDIR)/html/objects.inv ../user-manual/gslshell-index.inv
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
diff --git a/doc/gsl-shell-index/acknowledgments.rst b/doc/gsl-shell-index/acknowledgments.rst
index d4d1a2fd..c90dfc43 100644
--- a/doc/gsl-shell-index/acknowledgments.rst
+++ b/doc/gsl-shell-index/acknowledgments.rst
@@ -1,8 +1,12 @@
Acknowldgemets
--------------
-I would like to thanks the contributors of all the excellent free
-softwares that made GSL Shell possible. In particular thanks to the
-GSL Team for their excellent work, to the Lua team for their excellent scripting language.
+If GSL Shell exists is thanks to the many high quality free software projects on which it is based.
-Finally, thanks to my girlfriend, Gosia, for her patience and her support.
+The GSL team have made a great works over the years to bring an excellent, well thought, library for C programmers.
+Their work is even more remarkable thanks to the complete and accurate documentation.
+The GSL library deserves the merit of having opened the way to access high quality numerical routines for the non specialists of FORTRAN.
+
+Many thanks also to the Lua community for publishing their work under a free software license and to Maxim Shemarev for his great AGG library.
+
+Finally I would like to thanks to my wife, Gosia, for her patience and her support.
diff --git a/doc/gsl-shell-index/conf.py b/doc/gsl-shell-index/conf.py
index 0c717a97..425377f6 100644
--- a/doc/gsl-shell-index/conf.py
+++ b/doc/gsl-shell-index/conf.py
@@ -217,5 +217,4 @@ man_pages = [
# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'gslshell': ('http://www.nongnu.org/gsl-shell', 'manual.inv')}
-
+#intersphinx_mapping = {'gslshell': ('http://www.nongnu.org/gsl-shell/doc-current/', 'manual.inv')}
diff --git a/doc/gsl-shell-index/index.rst b/doc/gsl-shell-index/index.rst
index db1d5ea3..8a1f8c09 100644
--- a/doc/gsl-shell-index/index.rst
+++ b/doc/gsl-shell-index/index.rst
@@ -1,24 +1,46 @@
-##################################
-Welcome to GSL shell documentation
-##################################
+#####################
+The GSL Shell Project
+#####################
GSL shell is an interactive command line interface that gives easy access
to the GNU Scientific Library (GSL) collection of mathematical methods for
numerical computations.
GSL shell can be used interactively to perform calculations with matrices or
-vectors but it does allow also to write complex user defined functions with
-the Lua scripting interpreter.
+vectors but it does allow also to write complex user defined functions based on the Lua programming language.
-Lua is a very interesting and easy to learn scripting language that features
-advanced functionalities like closures and metamethods. Lua is very
-easy to learn and will give you the power of defining your own complex routines
-to use the GSL library more effectively.
+Lua is a very interesting and easy to learn scripting language that features advanced functionalities like closures and metamethods.
+Lua is very easy to learn and will give you the power of defining your own complex routines to use the GSL library more easily.
GSL Shell is hosted at `Savannah <http://savannah.nongnu.org>`_, here is the `project page <https://savannah.nongnu.org/projects/gsl-shell/>`_.
-You can download the latest release of GSL Shell in the `download page <https://savannah.nongnu.org/files/?group=gsl-shell>`_. You will find the source code, a binary package that require GSL 1.14 (or more recent) and readline5.
+You can download the latest release of GSL Shell in the `download page <https://savannah.nongnu.org/files/?group=gsl-shell>`_.
+You will find the source code and the binary packages for Windows and Linux.
+
+**NEW**
+ *The new GSL Shell 2 is in beta release*.
+
+ This new release of GSL Shell is a major change both in term of features and implementation.
+
+ First the functions are now organized into different modules for a greater clarity of the code.
+ Then the semantic of the arithmentic operations with numbers and matrix is now much more user-friendly.
+ The multiplication operator '*' it does perform now the matrix multiplication and you can mix freely complex and real number or matrices.
+
+ Under the hood there even more important changes since GSL Shell is now based on `LuaJIT2 <http://luajit.org>`_.
+ This latter is an highly optimized implementation of the Lua programming language.
+ LuaJIT2 is able to generate on the fly optimized machine code so that many programs can run at the speed of native code.
+ In addition, with the FFI module, you can call directly C functions opening the way to an incredible set of new applications.
+
+ The modules about numerical integration, ODE integration and non-linear fit have been *reimplemented* in Lua using direct FFI call to C functions.
+ The result is a greatly improved execution performance on par with optimized code.
+
+ Check the *demos* available in GSL Shell.
+ You may check the 'wave' demo that simulate a *quantum spinless particle in a step potential*.
+ Thanks to LuaJIT2 the demo run in realtime at an amazing speed.
+
+Donate
+~~~~~~
GSL shell is free software, everyone can freely use it, adapt or study the source code. You can contribute to its development by making a donation:
@@ -27,17 +49,21 @@ GSL shell is free software, everyone can freely use it, adapt or study the sourc
:ref:`Why donate <why-donate>`
-You can subscribe the `mailing list <http://lists.nongnu.org/mailman/listinfo/gsl-shell-info>`_ to discuss about GSL Shell. The author of the software is Francesco Abbate, you can contact him at the followng address:
+GSL Shell User Manual
+~~~~~~~~~~~~~~~~~~~~~
-.. image:: email-gslshell.png
+GSL Shell comes with a quite complete `user manual <http://www.nongnu.org/gsl-shell/doc/>`_.
+If you want to learn more about GSL Shell you can read with the `introduction to GSL Shell <http://www.nongnu.org/gsl-shell/doc/intro.html>`_.
+You may also give a look to the `examples section <http://www.nongnu.org/gsl-shell/doc/examples.html>`_ to get a feeling of GSL Shell.
-Here the :ref:`manual <gsl-shell-manual-index>`.
+.. note::
+ The manual GSL Shell 1.1 is still `available here <http://www.nongnu.org/gsl-shell/doc-v1/>`_.
Contents:
.. toctree::
:maxdepth: 2
- news.rst
why-donate.rst
acknowledgments.rst
+ older-news.rst
diff --git a/doc/gsl-shell-index/news.rst b/doc/gsl-shell-index/older-news.rst
index 21dabcaf..894bbd58 100644
--- a/doc/gsl-shell-index/news.rst
+++ b/doc/gsl-shell-index/older-news.rst
@@ -1,7 +1,7 @@
.. highlight:: lua
-News
-====
+Older News
+==========
**January 2011**
Release of GSL Shell 1.1
@@ -74,9 +74,9 @@ News
- in version 0.9.6 we have also introduced the support for alpha blending.
- * many :ref:`special functions <special-functions>` defined in the GSL library are now available from GSL shell.
+ * many special functions defined in the GSL library are now available from GSL shell.
- * the chapter with the :ref:`examples <gsl-shell-examples>` have been updated with some examples to produce beautiful fractals curves.
+ * the chapter with the GSL Shell examples have been updated with some examples to produce beautiful fractals curves.
**16 October 2009**
GSL Shell version alpha 0.6 released.
diff --git a/doc/gsl-shell-index/why-donate.rst b/doc/gsl-shell-index/why-donate.rst
index 222655f9..e2039b77 100644
--- a/doc/gsl-shell-index/why-donate.rst
+++ b/doc/gsl-shell-index/why-donate.rst
@@ -26,8 +26,6 @@ If you donate you can also choose which feature should be implemented in GSL she
* development of a full featured, openGL based, 3D graphics module
* develoment of a Graphical User Interface module to generate easily user interface to interact with plots by using GSL Shell/Lua functions
-* development of a Just In Time compiler to compile mathematical expression of the fly for optimal speed on repeated expression evaluations.
- **Note**: this feature is already under development by using the LLVM compiler infrastructure
* developement of a most versatile plot class that allows to create customized axes labels and legends.
* development of a postscript backend to generate image in PostScript or EPS format
diff --git a/doc/user-manual/Makefile b/doc/user-manual/Makefile
index c2a54ca3..9dc8a958 100644
--- a/doc/user-manual/Makefile
+++ b/doc/user-manual/Makefile
@@ -38,7 +38,6 @@ clean:
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- cp $(BUILDDIR)/html/objects.inv ../gsl-shell-index/manual.inv
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
diff --git a/doc/user-manual/conf.py b/doc/user-manual/conf.py
index 01538d87..aad459b0 100644
--- a/doc/user-manual/conf.py
+++ b/doc/user-manual/conf.py
@@ -50,7 +50,7 @@ copyright = u'2009-2011, Francesco Abbate'
# The short X.Y version.
version = '2.0'
# The full version, including alpha/beta/rc tags.
-release = '2.0-alpha'
+release = '2.0-beta1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -217,5 +217,4 @@ man_pages = [
# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'gslshell': ('http://www.nongnu.org/gsl-shell/', 'gslshell-index.inv')}
-
+# intersphinx_mapping = {'gslshell': ('http://www.nongnu.org/gsl-shell/', 'gslshell-index.inv')}
diff --git a/doc/user-manual/index.rst b/doc/user-manual/index.rst
index 3d9d9309..b800b5ad 100644
--- a/doc/user-manual/index.rst
+++ b/doc/user-manual/index.rst
@@ -1,5 +1,3 @@
-.. _gsl-shell-manual-index:
-
##################################
Welcome to GSL shell documentation
##################################
diff --git a/doc/user-manual/intro.rst b/doc/user-manual/intro.rst
index 2fed68a8..2ef3a27b 100644
--- a/doc/user-manual/intro.rst
+++ b/doc/user-manual/intro.rst
@@ -163,7 +163,7 @@ The double indexing method can be slow and should be probably avoided in the tig
In this case you should use the methods :meth:`~Matrix.get` and :meth:`~Matrix.set`.
Another opportunity is to adress directly matrix data by using its ``data`` field but this requires a particular attention since this kind of operations are not safe and you could easily crash the application.
-You can find more details in the chapter about :ref:`Matrix Direct Access <matrix-direct-access>`.
+You can find more details in the chapter about :ref:`GSL FFI interface <gsl-ffi-interface>`.
Plotting functions
~~~~~~~~~~~~~~~~~~
diff --git a/doc/user-manual/randist.rst b/doc/user-manual/randist.rst
index 4f11b919..954ba1f7 100644
--- a/doc/user-manual/randist.rst
+++ b/doc/user-manual/randist.rst
@@ -27,7 +27,7 @@ The library also provides cumulative distribution functions and
inverse cumulative distribution functions, sometimes referred to as
quantile functions. The cumulative distribution functions and their
inverses are computed separately for the upper and lower tails of the
-distribution, allowing full accuracy to be retained for small results. See the chapter :ref:`cdf-section` for more details.
+distribution, allowing full accuracy to be retained for small results.
.. _rnd_gaussian:
generated by cgit v1.2.3 (git 2.25.1) at 2025年10月04日 15:26:31 +0000

AltStyle によって変換されたページ (->オリジナル) /