You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-20
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
-
<aname=top></a>
1
+
<aname=top></a>
2
2
3
3
# Content<aname=content></a>
4
4
5
-
*[Examples using the NAG Library for Python](#examples)
6
-
*[How to install the NAG Library for Python](#install)
5
+
*[Examples using the *n*AG Library for Python](#examples)
6
+
*[How to install the *n*AG Library for Python](#install)
7
7
*[How to run the Jupyter notebook examples](#jupyter)
8
-
*[List of Chapters in the NAG Library for Python](#chapters)
8
+
*[List of Chapters in the *n*AG Library for Python](#chapters)
9
9
*[Useful links](#links)
10
10
11
-
# Examples using the NAG Library for Python <aname=examples></a>
11
+
# Examples using the *n*AG Library for Python <aname=examples></a>
12
12
13
-
This repository contains examples and demonstrations using the [NAG Library for Python](https://nag.com/nag-library/). The NAG Library for Python contains 1900+ functions spanning many areas of numerical computing and data science.
13
+
This repository contains examples and demonstrations using the [*n*AG Library for Python](https://nag.com/nag-library/). The *n*AG Library for Python contains 1900+ functions spanning many areas of numerical computing and data science.
14
14
15
-
Designed to work alongside the open source Python packages, [Numpy](http://www.numpy.org/) and [Scipy](https://www.scipy.org/), The NAG Library for Python can augment your computational workflow in many areas.
15
+
Designed to work alongside the open source Python packages, [Numpy](http://www.numpy.org/) and [Scipy](https://www.scipy.org/), The *n*AG Library for Python can augment your computational workflow in many areas.
16
16
17
17
## Directory of GitHub examples
18
18
@@ -31,26 +31,26 @@ Designed to work alongside the open source Python packages, [Numpy](http://www.n
31
31
32
32
## Examples that ship with the product
33
33
34
-
In addition to those presented here, The NAG Library for Python ships with a set of usage examples. To see them all, run the following command
34
+
In addition to those presented here, The *n*AG Library for Python ships with a set of usage examples. To see them all, run the following command
35
35
36
36
```
37
37
python -m naginterfaces.library.examples --locate
38
38
```
39
39
40
-
# How to install the NAG Library for Python<aname=install></a>
40
+
# How to install the *n*AG Library for Python<aname=install></a>
41
41
42
-
In this section we illustrate how to install the NAG Library for Python, request a Trial Licence and make sure the Library is working. Details and further information regarding the installation can be found [here](https://www.nag.com/numeric/py/nagdoc_latest/readme.html#installation).
42
+
In this section we illustrate how to install the *n*AG Library for Python, request a Trial Licence and make sure the Library is working. Details and further information regarding the installation can be found [here](https://www.nag.com/numeric/py/nagdoc_latest/readme.html#installation).
43
43
44
44
**Note** Before starting make sure you have access to a host that has Python 3 (3.4 or more recent).
45
45
46
46
### Step 1. Downloading and installing
47
-
Installing the NAG Library is done using the `pip` package manager, fire-up a terminal and create a Python 3 virtual environment where to install and test the NAG Library
47
+
Installing the *n*AG Library is done using the `pip` package manager, fire-up a terminal and create a Python 3 virtual environment where to install and test the *n*AG Library
48
48
```{bash}
49
49
guest@nag-37:~$ python3 -m venv nag3
50
50
guest@nag-37:~$ . nag3/bin/activate
51
51
(nag3) guest@nag-37:~$
52
52
```
53
-
Now use `pip` to install the NAG Library for Python
53
+
Now use `pip` to install the *n*AG Library for Python
@@ -79,7 +79,7 @@ The next step is to get the licensing info (**product code** and **KUSARI ID**)
79
79
```
80
80
The output should be similar to
81
81
```
82
-
The NAG Library for Python on this platform uses
82
+
The *n*AG Library for Python on this platform uses
83
83
underlying Library NLL6I271VL.
84
84
This Library has been installed as part of the package
85
85
and it requires a valid licence key.
@@ -106,7 +106,7 @@ The **two** important bits are the
106
106
107
107
**Note** that the **product code** and **KUSARI ID** can be different from the previous example.
108
108
109
-
With these, you are set to [contact NAG and request a trial licence](https://nag.com/contact-us/).
109
+
With these, you are set to [contact *n*AG and request a trial licence](https://nag.com/contact-us/).
110
110
111
111
The trial licence is a plain text chunk similar to
112
112
```
@@ -116,8 +116,8 @@ The **two** important bits are the
116
116
117
117
The final step is to make sure the licence is valid and the library is working as expected.
118
118
119
-
### Step 3. Testing the NAG Library
120
-
The last step is to make sure the licence was correctly stored and that the NAG Library is working correctly. From the same virtual terminal re-run the Kusari licence module
119
+
### Step 3. Testing the *n*AG Library
120
+
The last step is to make sure the licence was correctly stored and that the *n*AG Library is working correctly. From the same virtual terminal re-run the Kusari licence module
@@ -165,7 +165,7 @@ Run `python -m naginterfaces.library.examples --help` to see any additional usag
165
165
# How to run the Jupyter notebook examples<aname=jupyter></a>
166
166
167
167
This section briefly illustrates how to setup a host in order to open and run the [Jupyter notebooks](https://jupyter.org/) provided in this repository.
168
-
Before running the notebooks make sure the [NAG Library is installed and working](#install). Before starting, it is advised to read [Jupyter's installation page](https://jupyter.org/install.html).
168
+
Before running the notebooks make sure the [*n*AG Library is installed and working](#install). Before starting, it is advised to read [Jupyter's installation page](https://jupyter.org/install.html).
169
169
170
170
<!-- You can [view a static render of the notebooks using Jupyter's nbviewer here](https://nbviewer.jupyter.org/github/numericalalgorithmsgroup/NAGPythonExamples/tree/master/local_optimization/)
0 commit comments