diff options
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 52 |
1 files changed, 36 insertions, 16 deletions
diff --git a/doc/README.md b/doc/README.md index 8fb364f..9568d90 100644 --- a/doc/README.md +++ b/doc/README.md @@ -26,9 +26,9 @@ along with STK. If not, see <http://www.gnu.org/licenses/>. ## General information - Version: 2.7.0 (2022-02-23) + Version: 2.8.1 (2023-07-01) - Authors: See AUTHORS.md file + Authors: See [AUTHORS](./AUTHORS.md) file Maintainers: Julien Bect <julien.bect@centralesupelec.fr> and Emmanuel Vazquez <emmanuel.vazquez@centralesupelec.fr> @@ -47,7 +47,7 @@ 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-2022 CentraleSupelec. + and Copyright (C) 2015-2023 CentraleSupelec. See individual copyright notices for more details. License: GNU General Public License, version 3 (GPLv3). @@ -96,8 +96,11 @@ 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 the `stk_example_` prefix. -For instance, type `stk_example_kb03` to run the third example in the "Kriging -basics" series. +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: @@ -105,10 +108,12 @@ 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` +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/) [file release system](https://sourceforge.net/projects/octave/files/) @@ -116,12 +121,21 @@ on SourceForge and install it for you. Alternatively, if you want to install an older (or beta) release, you can download the tarball from either the STK project FRS or the Octave Forge FRS, and install it -with `pkg install FILENAME.tar.gz`. +with +``` +pkg install FILENAME.tar.gz +``` -After that, you can load STK using `pkg load stk`. +After that, you can load STK using +``` +pkg load stk +``` -To check that STK is properly loaded, try for instance `stk_example_kb03` to run -the third example in the "Kriging basics" series. +To check that STK is properly loaded, try for instance +``` +stk_example_kb03 +``` +to run the third example in the "kriging basics" series. ## Requirements and recommendations @@ -132,14 +146,13 @@ 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 4.0.0 or newer](https://wiki.octave.org/Release_History). - + The STK is tested to work with + [GNU Octave 4.0.1 or newer](https://wiki.octave.org/Release_History). ### Requirements and recommendations for use with Matlab The STK is tested to work with - [Matlab R2009b or newer](https://en.wikipedia.org/wiki/MATLAB#Release_history). + [Matlab R2014a or newer](https://en.wikipedia.org/wiki/MATLAB#Release_history). The Optimization Toolbox is recommended. @@ -200,5 +213,12 @@ DOI: 10.1007/s11222-011-9241-4. to report bugs or ask for new features (do not hesitate to do so!). If you use STK in Octave, you can also have a look there: - + <https://octave.sourceforge.io/support-help.php> + + +## How to contribute + + The contribution process is explained in + [CONTRIBUTING.md](https://github.com/stk-kriging/stk/blob/master/.github/CONTRIBUTING.md). + |