Skip to content

Commit 9c25e87

Browse files
jjokellajjokella
committed
doc: Deprecation warnings and links to TSMP2(-PDAF) software
1 parent f55671f commit 9c25e87

31 files changed

+265
-0
lines changed

‎doc/content/build_tsmp/build_examples.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Building TSMP #
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
These are example builds of TSMP that are frequently tested.
412

513
## Build script of TSMP

‎doc/content/build_tsmp/build_examples_tsmp.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# TSMP Build Examples #
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
**Attention**: Not all of this examples were tested and paths are
412
mostly made up.
513

‎doc/content/build_tsmp/build_examples_tsmppdaf.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# TSMP-PDAF Build Examples #
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
A collection of build examples for TSMP-PDAF.
412

513
All builds involving more than one coupled component model use the

‎doc/content/build_tsmp/build_preprocessor_variables.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# TSMP-PDAF Preprocessor variables #
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
A number of preprocessor variables are set during the build process of
412
TSMP-PDAF in order to make the code behave in specific ways.
513

‎doc/content/build_tsmp/intf_da.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Structure of DA inside TSMP #
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
The directory `intf_DA` holds the interfaces of the component models
412
to data assimilation frameworks (`dart`, `kenda` (currently not in
513
`master`) and `pdaf`) alongside scripts for building the data

‎doc/content/build_tsmp/obtain_code.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,23 @@
11
# Obtaining the code
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
## TSMP
412

13+
```{danger}
14+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
15+
Please refer to the updated documentation for current information.
16+
17+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
18+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
19+
```
20+
521
The source code of TSMP (Terrestrial System Modeling Platform) can be obtained from a git-repository hosted on Github:
622
<https://github.com/HPSCTerrSys/TSMP>. On this website, a README file explains how to run TSMP for the first time on Linux.
723

@@ -23,6 +39,14 @@ There is also a public TSMP Virtual Machine available for download. This is a Ub
2339

2440
## TSMP-PDAF
2541

42+
```{danger}
43+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
44+
Please refer to the updated documentation for current information.
45+
46+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
47+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
48+
```
49+
2650
Commands for cloning TSMP-PDAF (https or ssh):
2751
```bash
2852
git clone https://github.com/HPSCTerrSys/TSMP TSMP

‎doc/content/build_tsmp/pdaf.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Structure of PDAF inside TSMP
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
```{toctree}
412
---
513
maxdepth: 3

‎doc/content/build_tsmp/structure.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Structure of TSMP #
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
After cloning TSMP into a directory, for example `TSMP`, you obtain a fixed top level folder structure. This folder structured is discussed in this section.
412

513
## Component model directories and PDAF directory ##

‎doc/content/debugging/debug_tips.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Debug tips
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
## Debug Tip 1: Skip component models in TSMP-PDAF build
412

513
``` shell

‎doc/content/debugging/debug_tsmp2.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Debugging TSMP2-PDAF
22

3+
```{danger}
4+
**DEPRECATED**: This documentation is deprecated and no longer maintained.
5+
Please refer to the updated documentation for current information.
6+
7+
- TSMP2: <https://hpscterrsys.github.io/TSMP2>
8+
- TSMP-PDAF: <https://hpscterrsys.github.io/pdaf>
9+
```
10+
311
## Debug Tip 1: Build with debug version
412

513
The following command will build eCLM-PDAF in debug version

0 commit comments

Comments
 (0)