Skip to content

Commit 55bcf11

Browse files
committed
Merge branch 'main' of github.com:ray-chew/spec_appx
2 parents d455f70 + a724979 commit 55bcf11

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<p align="center">
2-
<a href="https://ray-chew.github.io/spec_appx/index.html">
3-
<img alt="CSAM Logo" src="https://ray-chew.github.io/spec_appx/_static/logo.png">
2+
<a href="https://ray-chew.github.io/pyCSAM/index.html">
3+
<img alt="CSAM Logo" src="https://ray-chew.github.io/pyCSAM/_static/logo.png">
44
</a>
55
</p>
66

77
<h2 align="center">Constrained Spectral Approximation Method</h2>
88

99

1010
<p align="center">
11-
<a href="https://github.com/ray-chew/spec_appx/actions/workflows/documentation.yml">
12-
<img alt="GitHub Actions: docs" src=https://github.com/ray-chew/spec_appx/actions/workflows/documentation.yml/badge.svg>
11+
<a href="https://github.com/ray-chew/pyCSAM/actions/workflows/documentation.yml">
12+
<img alt="GitHub Actions: docs" src=https://img.shields.io/github/actions/workflow/status/ray-chew/pyCSAM/documentation.yml?logo=github&label=docs>
1313
</a>
1414
<a href="https://www.gnu.org/licenses/gpl-3.0">
1515
<img alt="License: GPL v3" src=https://img.shields.io/badge/License-GPLv3-blue.svg>
@@ -32,15 +32,15 @@ This method is primarily used to represent terrain for weather forecasting purpo
3232

3333
---
3434

35-
**[Read the documentation here](https://ray-chew.github.io/spec_appx/index.html)**
35+
**[Read the documentation here](https://ray-chew.github.io/pyCSAM/index.html)**
3636

3737
---
3838

3939
## Requirements
4040

41-
See [`requirements.txt`](https://github.com/ray-chew/spec_appx/blob/main/requirements.txt)
41+
See [`requirements.txt`](https://github.com/ray-chew/pyCSAM/blob/main/requirements.txt)
4242

43-
> **NOTE:** The Sphinx dependencies can be found in [`docs/conf.py`](https://github.com/ray-chew/spec_appx/blob/main/docs/source/conf.py).
43+
> **NOTE:** The Sphinx dependencies can be found in [`docs/conf.py`](https://github.com/ray-chew/pyCSAM/blob/main/docs/source/conf.py).
4444
4545

4646
## Usage
@@ -51,17 +51,17 @@ Fork this repository and clone your remote fork.
5151

5252
### Configuration
5353

54-
The user-defined input parameters are in the [`inputs`](https://github.com/ray-chew/spec_appx/tree/main/inputs) subpackage. These parameters are imported into the run scripts in [`runs`](https://github.com/ray-chew/spec_appx/tree/main/runs).
54+
The user-defined input parameters are in the [`inputs`](https://github.com/ray-chew/pyCSAM/tree/main/inputs) subpackage. These parameters are imported into the run scripts in [`runs`](https://github.com/ray-chew/pyCSAM/tree/main/runs).
5555

5656
### Execution
5757

58-
A simple setup can be found in [`runs.idealised_isosceles`](https://github.com/ray-chew/spec_appx/blob/main/runs/idealised_isosceles.py). To execute this run script:
58+
A simple setup can be found in [`runs.idealised_isosceles`](https://github.com/ray-chew/pyCSAM/blob/main/runs/idealised_isosceles.py). To execute this run script:
5959

6060
```console
6161
python3 ./runs/idealised_isosceles.py
6262
```
6363

64-
However, the codebase is structured such that the user can easily assemble a run script to define their own experiments. Refer to the documentation for the [available APIs](https://ray-chew.github.io/spec_appx/api.html).
64+
However, the codebase is structured such that the user can easily assemble a run script to define their own experiments. Refer to the documentation for the [available APIs](https://ray-chew.github.io/pyCSAM/api.html).
6565

6666
## License
6767

0 commit comments

Comments
 (0)