@abi-software/simulationvuer 2.0.14 → 2.0.15

package/README.md

@@ -1,18 +1,15 @@
 # SimulationVuer
 
-SimulationVuer is a [Vue](https://vuejs.org/) component used in the [SPARC portal](https://sparc.science/) to run some simulation-based [datasets](https://sparc.science/data?type=dataset).
-Some of those datasets (e.g., [135](https://sparc.science/datasets/135?type=simulation) and [157](https://sparc.science/datasets/157?type=simulation)) reference a [CellML](https://cellml.org/)-based model of some biological process and include a [JSON](https://json.org/) file.
+SimulationVuer is a [Vue](https://vuejs.org/) 3 component used in the [SPARC portal](https://sparc.science/) to run some simulation-based [datasets](https://sparc.science/data?type=dataset) that include a [JSON](https://json.org/) file. That JSON file is used by SimulationVuer to create a user interface (Fig. 1) which can then be used by someone to configure a simulation before running it.
 
-The JSON file is used by SimulationVuer to create a user interface (Fig. 1).
-The interface can then be used by someone to configure the simulation and then run it.
-Using the [SPARC API](https://github.com/nih-sparc/sparc-api), SimulationVuer asks [oSPARC](https://osparc.io/) to run the model (using its [OpenCOR](https://opencor.ws/)-based service) and to retrieve the simulation results, which can then be visualised and interacted with using the interface.
+The simulation is run either on [oSPARC](https://osparc.io/) or in a user's browser, depending on how the simulation-based dataset is referenced (see the  `id` property below). In the oSPARC case, SimulationVuer relies on the [SPARC API](https://github.com/nih-sparc/sparc-api) to ask oSPARC to run the model and to retrieve the simulation results, which can then be visualised and interacted with using the interface.
 
 ![SimulationVuer](res/135.png)
 *Figure 1: user interface for dataset [135](https://sparc.science/datasets/simulationviewer?id=135).*
 
 ## How to use
 
-To install the package to your Vue application:
+To install the package in your Vue application:
 
 ```bash
 npm install @abi-software/simulationvuer
@@ -24,7 +21,7 @@ To include the package in your script:
 import { SimulationVuer } from '@abi-software/simulationvuer';
 ```
 
-To register in a Vue component:
+To register the package as a Vue component:
 
 ```javascript
 export default {
@@ -38,14 +35,21 @@ export default {
 }
 ```
 
-The above registers the SimulationVuer component into the global scope.
-You can now use the SimulationVuer in your Vue template as follows:
+The above registers the SimulationVuer component into the global scope. You can now use SimulationVuer in your Vue template as follows:
 
 ```html
 <SimulationVuer :apiLocation="apiLocation" :id=123 />
 ```
 
-where `apiLocation` is the URL to the API location and `id` the id of the simulation-based dataset, if it is a number, or the path to a PMR file, if it is a string.
+where:
+ - `apiLocation` is the URL of a running copy of the [SPARC API](https://github.com/nih-sparc/sparc-api); and
+ - `id` is:
+   - the id of a SPARC simulation-based dataset (as a `Number`, e.g., `135`);
+   - the [PMR](https://models.physiomeproject.org/) path to an [OMEX](https://combinearchive.org/) file (as a `String`, e.g., `workspace/b7c/rawfile/e0ae8d2d56aaaa091e23e1ee7e84cacbda1dfb6b/135.omex`);
+   - the direct URL to an OMEX file (as a `String`, e.g., `https://raw.githubusercontent.com/opencor/webapp/refs/heads/main/tests/models/ui/135.omex`); or
+   - a raw OMEX file (as a `Uint8Array`).
+
+Note that a simulation will be run on oSPARC if the `id` references a SPARC simulation-based dataset, in a user's browser otherwise.
 
 ## Project setup
 
@@ -77,8 +81,7 @@ npm run build-bundle
 
 ## Vue 2 vs. Vue 3
 
-SimulationVuer is now being developed as a Vue 3 component only.
-The [Vue 2 version of SimulationVuer](https://github.com/ABI-Software/simulationvuer/tree/vue2) is not maintained anymore.
+SimulationVuer is now being developed as a Vue 3 component only. The [Vue 2 version of SimulationVuer](https://github.com/ABI-Software/simulationvuer/tree/vue2) is not maintained anymore.
 
 ## Documentation