Skip to content

Commit fe21507

Browse files
doc-fix: fix links in benefits of using dart
fixes #829 Added anchors to linked sections Fixed typos in guide/contributors-guide.rst
1 parent fd3a813 commit fe21507

6 files changed

+21
-12
lines changed

guide/adding-your-observations-to-dart.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _adding-your-observations-to-dart:
2+
13
Adding your observations to DART
24
================================
35

guide/benefits-of-using-dart.rst

+9-10
Original file line numberDiff line numberDiff line change
@@ -34,32 +34,31 @@ Here are some of the many benefits of using DART:
3434
system provided that you maintain the license and copyright information. Of
3535
course, we also ask that you credit DART in your publications, and kindly ask
3636
that you contribute your modifications so that other users may benefit. See
37-
`How should I cite DART? <#citeDart>`__ and `How can I contribute to
38-
DART? <#ContributeToDart>`__ for more information.
37+
:ref:`How should I cite DART?<citeDART>` and :ref:`How can I contribute to
38+
DART? <contributors-guide>` for more information.
3939
2. DART is **fully parallel and carefully engineered** to run on systems ranging
4040
from single-core research computers to the top performing multicore
4141
supercomputers in the world. Writing scalable parallel code is arguably the
4242
most difficult and time-consuming task in scientific computing today, but
4343
DART has already carefully implemented and tested this project, and the code
4444
is available for you to use out-of-the-box. For more information on how DART
45-
was written (and continues to be developed), see `DART’s design
46-
philosophy <#dartDesign>`__.
45+
was written (and continues to be developed), see :ref:`dart-design-philosophy`.
4746
3. DART contains **numerous tools that accelerate getting started** on both
4847
research and “real-world” problems. Multiple rigorously tested inflation,
4948
localization, perturbation, and other auxiliary data assimilation algorithms
50-
are available for immediate use and testing. See `Important capabilities of
51-
DART <#dartCapabilities>`__ for more information.
49+
are available for immediate use and testing. See :ref:`important-capabilities-dart`
50+
for more information.
5251
4. DART **makes adding a new model straightforward**. A new model only needs to
5352
implement a list of (at most) 18 core functions or use the default behavior
54-
if applicable to take advantage of DARTs mature and robust DA algorithms. A
53+
if applicable to take advantage of DART's mature and robust DA algorithms. A
5554
basic data assimilation system for a large model can be built in
5655
person-weeks, and comprehensive systems have been built in a few months. See
57-
`How do I run DART with my model? <#RunWithMyModel>`__ for more information.
56+
:ref:`Using new models` for more information.
5857
5. DART **makes it easy to add new observations** in order to test their
5958
potential beneficial impact. Incorporating new observation types only
6059
requires creating a forward operator that computes the expected value of an
61-
observation given a models state. See `How do I add my observations to
62-
DART? <#RunWithMyObs>`__ for more information.
60+
observation given a model's state. See :ref:`How do I add my observations to
61+
DART? <adding-your-observations-to-dart>` for more information.
6362
6. DART **can be used to test new DA algorithms**. Many such algorithms have
6463
been successfully implemented, tested, and published using DART. This is not
6564
covered in this getting started guide as this is an “advanced user”

guide/contributors-guide.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _contributors-guide:
2+
13
Contributors' guide
24
===================
35

@@ -15,10 +17,10 @@ All of the source code is hosted in the `DART GitHub repository
1517
<https://github.com/NCAR/DART>`__.
1618

1719
Before you start developing, you should be familiar with the `GitHub
18-
workflow <https://guides.github.com/introduction/flow/>`_. The GitHub worflow
20+
workflow <https://guides.github.com/introduction/flow/>`_. The GitHub workflow
1921
involves:
2022

21-
1. Creating a *fork* of the DART project. A fork is a publically visible copy
23+
1. Creating a *fork* of the DART project. A fork is a publicly visible copy
2224
of the repository that is stored in your GitHub account.
2325
2. Creating a *branch* for your feature with an appropriate name for your
2426
project, and when you are finished with your changes you can commit them

guide/dart-design-philosophy.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _dart-design-philosophy:
2+
13
DART’s design philosophy
24
========================
35

guide/important-capabilities-dart.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _important-capabilities-dart:
2+
13
Important capabilities of DART
24
==============================
35

index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,8 @@ Download the appropriate tar file and untar it into your DART repository. Ignore
241241
any warnings about ``tar: Ignoring unknown extended header keyword``.
242242

243243

244+
.. _citeDART:
245+
244246
Citing DART
245247
-----------
246248

0 commit comments

Comments
 (0)