Skip to content

Tidy the README links and the documentation badge #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SMI-Lab-Inha merged 2 commits into from
Oct 16, 2026
Merged

Tidy the README links and the documentation badge #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
795e299
Name the linked project files in the README by their purpose.
SMI-Lab-Inha Oct 16, 2026
1534bc5
Serve the documentation badge from shields.io.
SMI-Lab-Inha Oct 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![Release](https://img.shields.io/github/v/release/SMI-Lab-Inha/VANE?sort=semver)](https://github.com/SMI-Lab-Inha/VANE/releases/latest)
[![CI](https://github.com/SMI-Lab-Inha/VANE/actions/workflows/python.yml/badge.svg)](https://github.com/SMI-Lab-Inha/VANE/actions/workflows/python.yml)
[![Documentation](https://readthedocs.org/projects/vane/badge/?version=latest)](https://vane.readthedocs.io/en/latest/)
[![Documentation](https://img.shields.io/readthedocs/vane/latest?label=docs)](https://vane.readthedocs.io/en/latest/)
[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
[![Python 3.10–3.13](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](pyproject.toml)

Expand Down Expand Up @@ -32,7 +32,7 @@ The public API is documented in the
[API reference](https://vane.readthedocs.io/en/latest/reference/api_reference.html) and
is stable. VANE follows semantic versioning: a breaking change to the documented public
API is made only with a new major version and is recorded in the
[CHANGELOG](CHANGELOG.md).
[changelog](CHANGELOG.md).

## Capabilities

Expand Down Expand Up @@ -111,7 +111,7 @@ vane study path/to/lin_files --parameter wind -o study_output
The manual at <https://vane.readthedocs.io> covers installation, the quick start, the
OpenFAST linearization sweep, mode identification, Campbell diagrams, state-space
export, azimuth averaging, step-by-step tutorials, the theory, the validation record,
and the API reference. The tutorial scripts are in [`examples/`](examples/README.md);
and the API reference. The tutorial scripts are in the [examples folder](examples/README.md);
all but the OpenFAST sweep run on synthetic inputs without OpenFAST.

## Validation
Expand All @@ -120,7 +120,8 @@ VANE is verified against analytical solutions, exact invariants and prescribed-m
models, and has been run end to end on the OpenFAST `r-test` reference systems (NREL
5 MW on land, OC3 monopile, OC3 Hywind spar, OC4 DeepCwind semi-submersible) and on
the NREL 5 MW and IEA 3.4, 10, 15 and 22 MW reference turbines. Cases, acceptance
values and the tests that reproduce them are in [VALIDATION.md](VALIDATION.md).
values and the tests that reproduce them are in the
[validation record](VALIDATION.md).

## Repository layout

Expand All @@ -132,23 +133,23 @@ values and the tests that reproduce them are in [VALIDATION.md](VALIDATION.md).
| `examples/` | Runnable tutorial scripts |
| `.github/` | Continuous integration, issue and pull-request templates |

The package structure is described in [ARCHITECTURE.md](ARCHITECTURE.md).
The package structure is described in the [architecture overview](ARCHITECTURE.md).

## Citing

If you use VANE in academic work, please cite the software release you used
(VANE 0.1.0). [CITATION.cff](CITATION.cff) holds the citation metadata (GitHub **Cite
this repository**); BibTeX is on the manual's
(VANE 0.1.0). The [citation file](CITATION.cff) holds the citation metadata (GitHub
**Cite this repository**); BibTeX is on the manual's
[How to cite](https://vane.readthedocs.io/en/latest/user_guide/citing.html) page.

## Contributing and support

Questions, bug reports and feature requests are welcome in
[GitHub Issues](https://github.com/SMI-Lab-Inha/VANE/issues); see
[SUPPORT.md](SUPPORT.md) for where each belongs. Read
[CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Everyone taking part
the [support guide](SUPPORT.md) for where each belongs. Read the
[contributing guide](CONTRIBUTING.md) before opening a pull request. Everyone taking part
is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md). Report security
issues privately as described in [SECURITY.md](SECURITY.md).
issues privately as described in the [security policy](SECURITY.md).

VANE is research software. Users are responsible for model selection, convergence
checks and the engineering decisions they base on its results.
Expand Down
Loading