Skip to content

Commit e150706

Browse files
Update README.md
brand updates
1 parent 3c2d7ed commit e150706

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
![NAG Logo](./nag_logo.png)<a name=top></a>
1+
![nAG Logo](./nag_logo.png)<a name=top></a>
22

33
# Content<a name=content></a>
44

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)
77
* [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)
99
* [Useful links](#links)
1010

11-
# Examples using the NAG Library for Python <a name=examples></a>
11+
# Examples using the *n*AG Library for Python <a name=examples></a>
1212

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.
1414

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.
1616

1717
## Directory of GitHub examples
1818

@@ -31,26 +31,26 @@ Designed to work alongside the open source Python packages, [Numpy](http://www.n
3131

3232
## Examples that ship with the product
3333

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
3535

3636
```
3737
python -m naginterfaces.library.examples --locate
3838
```
3939

40-
# How to install the NAG Library for Python<a name=install></a>
40+
# How to install the *n*AG Library for Python<a name=install></a>
4141

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).
4343

4444
**Note** Before starting make sure you have access to a host that has Python 3 (3.4 or more recent).
4545

4646
### 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
4848
```{bash}
4949
guest@nag-37:~$ python3 -m venv nag3
5050
guest@nag-37:~$ . nag3/bin/activate
5151
(nag3) guest@nag-37:~$
5252
```
53-
Now use `pip` to install the NAG Library for Python
53+
Now use `pip` to install the *n*AG Library for Python
5454
```{bash}
5555
(nag3) guest@nag-37:~$ python -m pip install --extra-index-url https://www.nag.com/downloads/py/naginterfaces_nag naginterfaces
5656
```
@@ -79,7 +79,7 @@ The next step is to get the licensing info (**product code** and **KUSARI ID**)
7979
```
8080
The output should be similar to
8181
```
82-
The NAG Library for Python on this platform uses
82+
The *n*AG Library for Python on this platform uses
8383
underlying Library NLL6I271VL.
8484
This Library has been installed as part of the package
8585
and it requires a valid licence key.
@@ -106,7 +106,7 @@ The **two** important bits are the
106106

107107
**Note** that the **product code** and **KUSARI ID** can be different from the previous example.
108108

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/).
110110

111111
The trial licence is a plain text chunk similar to
112112
```
@@ -116,8 +116,8 @@ The **two** important bits are the
116116

117117
The final step is to make sure the licence is valid and the library is working as expected.
118118

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
121121
```{bash}
122122
(nag3) guest@nag-37:~$ python -m naginterfaces.kusari
123123
```
@@ -165,7 +165,7 @@ Run `python -m naginterfaces.library.examples --help` to see any additional usag
165165
# How to run the Jupyter notebook examples<a name=jupyter></a>
166166

167167
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).
169169

170170
<!-- 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/)
171171
[![Jupyter](https://img.shields.io/badge/launch-nbviewer-blue?logo=jupyter&logoColor=white)](https://nbviewer.jupyter.org/github/numericalalgorithmsgroup/NAGPythonExamples/tree/master/local_optimization/)
@@ -174,7 +174,7 @@ or alternatively use [Binder](https://mybinder.org/) to [view them here](https:/
174174

175175

176176
### Installing Jupyter notebook
177-
To install Jupyter, launch a terminal and activate the virtual environment used to install the NAG Library for Python
177+
To install Jupyter, launch a terminal and activate the virtual environment used to install the *n*AG Library for Python
178178
```{bash}
179179
guest@nag-37:~$ . nag3/bin/activate
180180
(nag3) guest@nag-37:~$ pip install notebook matplotlib
@@ -211,7 +211,7 @@ This command will fire-up your web browser and open the `rosenbrock2d.ipynb` not
211211

212212

213213

214-
# List of Chapters in the NAG Library for Python<a name=chapters></a>
214+
# List of Chapters in the *n*AG Library for Python<a name=chapters></a>
215215

216216
The following links take you to the relevant section in the official documentation
217217

@@ -267,7 +267,7 @@ The following links take you to the relevant section in the official documentati
267267

268268
# Useful links<a name=links></a>
269269

270-
* [NAG Library for Python Documentation](https://www.nag.com/numeric/py/nagdoc_latest/naginterfaces.library.opt.html)
270+
* [*n*AG Library for Python Documentation](https://www.nag.com/numeric/py/nagdoc_latest/naginterfaces.library.opt.html)
271271
* [Kusari licence module Documentation](https://www.nag.com/numeric/py/nagdoc_latest/naginterfaces.kusari.html#kusari)
272272

273273

0 commit comments

Comments
 (0)