diff options
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 63 |
1 files changed, 41 insertions, 22 deletions
diff --git a/doc/README.md b/doc/README.md index 551b591..8fb364f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,10 +1,14 @@ - # STK: a Small (Matlab/Octave) Toolbox for Kriging +[](COPYING) +[](https://github.com/stk-kriging/stk/commits/main) +[](https://github.com/stk-kriging/stk/actions/workflows/run-tests.yml) +[](https://github.com/stk-kriging/stk/actions/workflows/run-linter.yml) + This README file is part of *STK: a Small (Matlab/Octave) Toolbox for Kriging* -<http://sourceforge.net/projects/kriging> +<https://github.com/stk-kriging/stk/> STK is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free @@ -22,7 +26,7 @@ along with STK. If not, see <http://www.gnu.org/licenses/>. ## General information - Version: 2.6.1 (2019-10-12) + Version: 2.7.0 (2022-02-23) Authors: See AUTHORS.md file @@ -43,13 +47,13 @@ along with STK. If not, see <http://www.gnu.org/licenses/>. Non-parametric Regression, etc.). Copyright: Large portions are Copyright (C) 2011-2014 SUPELEC - and Copyright (C) 2015-2019 CentraleSupelec. + and Copyright (C) 2015-2022 CentraleSupelec. See individual copyright notices for more details. License: GNU General Public License, version 3 (GPLv3). See COPYING for the full license. - URL: <http://sourceforge.net/projects/kriging> + URL: <https://github.com/stk-kriging/stk/> ## One toolbox, two flavours @@ -58,7 +62,7 @@ The STK toolbox comes in two flavours: * an "all purpose" release, which is suitable for use both with [GNU Octave](http://www.gnu.org/software/octave/) - and with [Matlab](www.mathworks.com/products/matlab/). + and with [Matlab](https://www.mathworks.com/products/matlab/). * an Octave package, for people who want to install and use STK as a regular [Octave package](http://www.gnu.org/software/octave/doc/interpreter/Packages.html#Packages). @@ -74,12 +78,19 @@ Hint: if you're not sure about the version that you have... ### Quick start with the "all purpose" release (Matlab/Octave) -Download and unpack an archive of the "all purpose" release from the -[STK project](https://sourceforge.net/projects/kriging/) -[file release system](https://sourceforge.net/projects/kriging/files/) -on SourceForge. +Download and unpack an archive of the "all purpose" +[release](https://github.com/stk-kriging/stk/releases). -Run `stk_init.m` in either Octave or Matlab. +Run `stk_init` in either Octave or Matlab. One way to do so is to navigate +to the root directory of STK and then simply type: +``` +stk_init +``` +Alternatively, if you don't want to change the current directory, you can use: +``` +run /path/to/stk/stk_init.m +``` +Note that this second approach is suitable for inclusion in your `startup` script. After that, you should be able to run the examples located in the `examples` directory. All of them are scripts, the file name of which starts with @@ -88,11 +99,18 @@ the `stk_example_` prefix. For instance, type `stk_example_kb03` to run the third example in the "Kriging basics" series. +Remark: when using STK with Mathworks' Parallel Computing Toolbox, it is +important to run `stk_init` within each worker. This can be achieved using: +``` +pctRunOnAll run /path/to/stk/stk_init.m +``` + + ### Quick start with the Octave package release (Octave only) Assuming that you have a working Internet connection, typing `pkg install -forge stk` (from within Octave) will automatically download the latest STK package tarball from the -[Octave Forge](http://octave.sourceforge.net/stk/index.html) +[Octave Forge](http://octave.sourceforge.net/) [file release system](https://sourceforge.net/projects/octave/files/) on SourceForge and install it for you. @@ -114,17 +132,14 @@ the third example in the "Kriging basics" series. ### Requirements and recommendations for use with GNU Octave - The STK is tested to work with GNU Octave 3.8.2 or newer, but - should probably also work with Octave 3.8.0 and 3.8.1. - - Older versions of Octave (<= 3.6.2) are no longer supported, and - are known to contain bugs that prevent some STK functions from - working properly. + The STK is tested to work with + [GNU Octave 4.0.0 or newer](https://wiki.octave.org/Release_History). ### Requirements and recommendations for use with Matlab - The STK works with Matlab R2007a or newer. + The STK is tested to work with + [Matlab R2009b or newer](https://en.wikipedia.org/wiki/MATLAB#Release_history). The Optimization Toolbox is recommended. @@ -176,10 +191,14 @@ DOI: 10.1007/s11222-011-9241-4. Use the "help" mailing-list: <kriging-help@lists.sourceforge.net> - <https://sourceforge.net/p/kriging/mailman> + (register/browse the archives: [here](https://sourceforge.net/p/kriging/mailman)) to ask for help on STK, and the ticket manager: - <https://sourceforge.net/p/kriging/tickets> + <https://github.com/stk-kriging/stk/issues> + + to report bugs or ask for new features (do not hesitate to do so!). - to report bugs or ask for new features. + If you use STK in Octave, you can also have a look there: + + <https://octave.sourceforge.io/support-help.php> |