@sdeverywhere/check-ui-shell 0.2.2 → 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -5
- package/dist/index.js +4849 -3131
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -1,11 +1,37 @@
|
|
|
1
1
|
# @sdeverywhere/check-ui-shell
|
|
2
2
|
|
|
3
|
-
This package provides a complete user interface for a model check/comparison
|
|
4
|
-
report as generated by SDEverywhere.
|
|
3
|
+
This package provides a complete user interface for a model check/comparison report as generated by [SDEverywhere](https://github.com/climateinteractive/SDEverywhere).
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
The best way to get started with SDEverywhere is to follow the [Quick Start](https://github.com/climateinteractive/SDEverywhere#quick-start) instructions.
|
|
8
|
+
If you follow those instructions, the `@sdeverywhere/plugin-check` package will be added to your project, and that package uses `@sdeverywhere/check-ui-shell` as an implementation detail.
|
|
9
|
+
Therefore, most users do not need to install this package directly.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
As noted above, most users do not need to install this package directly, but for more advanced use cases, it can be installed as follows.
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
# npm
|
|
17
|
+
npm install @sdeverywhere/check-ui-shell
|
|
18
|
+
|
|
19
|
+
# pnpm
|
|
20
|
+
pnpm add @sdeverywhere/check-ui-shell
|
|
21
|
+
|
|
22
|
+
# yarn
|
|
23
|
+
yarn add @sdeverywhere/check-ui-shell
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
Most users do not need to interact with the `@sdeverywhere/check-ui-shell` package directly; it is primarily used in the implementation of the `@sdeverywhere/plugin-check` package.
|
|
29
|
+
|
|
30
|
+
However, if you would like to build a custom tool for running checks and comparison tests on models, you can refer to the API documentation below for more details.
|
|
31
|
+
|
|
32
|
+
## Documentation
|
|
33
|
+
|
|
34
|
+
API documentation is available in the [`docs`](./docs/index.md) directory.
|
|
9
35
|
|
|
10
36
|
## License
|
|
11
37
|
|