Skip to content

Commit

Permalink
Merge pull request #6064 from gassmoeller/mention-vs-code-extension
Browse files Browse the repository at this point in the history
Mention VS code extension for input file editing
  • Loading branch information
bangerth authored Oct 9, 2024
2 parents e4fad72 + 90b08c4 commit 70129ef
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
8 changes: 8 additions & 0 deletions doc/modules/changes/20241009_guo
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
New: ASPECT now has a Visual Studio Code extension named
ASPECT (https://marketplace.visualstudio.com/items?itemName=zhikui.vscode-aspect).
This extension provides syntax highlighting and auto-completion for input parameter
files, and can display the documentation of input parameters while writing parameter
files in VS Code. It is now one of the recommended extensions for VS Code when using
ASPECT.
<br>
(Zhikui Guo, Timo Heister, Rene Gassmoeller, 2024/10/09)
17 changes: 14 additions & 3 deletions doc/sphinx/user/run-aspect/parameters-overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,20 @@ What ASPECT computes is driven by two things:
that is read at run time and whose name is specified on the command line.
(See also {ref}`sec:run-aspect:overview`.)

In this section, let us give an overview of what can be selected in the
parameter file. Specific parameters, their default values, and allowed values
for these parameters are documented in <https://aspect.geodynamics.org/doc/parameter_view/parameters.xml>.
In this section, let us give an overview of the structure of these input
parameter files. Specific parameters, their default values, and allowed values
for these parameters are documented on our
[parameter website](https://aspect.geodynamics.org/doc/parameter_view/parameters.xml),
and the {ref}`parameters` chapter of this documentation.

When writing or modifying parameter
files we strongly recommend to use [Visual Studio Code](https://code.visualstudio.com/)
with the [ASPECT extension](https://marketplace.visualstudio.com/items?itemName=zhikui.vscode-aspect).
This extension enables syntax highlighting,
auto-completion, and includes the documentation for all ASPECT parameters, thus greatly simplifying
the process of writing ASPECT parameter files. Take note that by default the extension will make
use of the input parameters of the latest ASPECT release. If you are using a different ASPECT
version you can change the settings of the extension.

:::{toctree}
structure.md
Expand Down

0 comments on commit 70129ef

Please sign in to comment.