Skip to content
Snippets Groups Projects
Commit 207f40a1 authored by Lene Wasskog's avatar Lene Wasskog
Browse files

chore: Minor change to trigger build

parent 3f1d4e6c
No related branches found
No related tags found
No related merge requests found
Pipeline #2508 passed
# VIPSCore
This is the server component that hosts the models. It is accessible via
VIPSCoreManager over http/REST. Models that are on the component's classpath
are autodetected, indexed and made available through the REST service. The service is used by
VIPSCoreManager over http/REST. Models that are on the component's classpath
are autodetected, indexed and made available through the REST service. The service is used by
[VIPSLogic](https://gitlab.nibio.no/VIPS/VIPSLogic) when running models. It can also be contacted directly by any client.
VIPSCore is a part of the [VIPS platform for automatic pest prediction](https://gitlab.nibio.no/VIPS/documentation)
## VIPSCoreManager
[VIPSCoreManager](https://gitlab.nibio.no/VIPS/VIPSCoreManager) is a layer in front of VIPSCore that handles authentication of clients and logging of usage. All services available in VIPSLogic are transparently accessible via VIPSCoreManager. Add this layer if you want to limit and log usage, and also if you want to set up e.g. scaling of VIPSCore instances.
![How VIPSCore and VIPSCoreManager fits into the whole VIPS architecture](./docs/illustrations/VIPS_whole_architecture.png "All VIPS system parts")
......@@ -14,14 +16,19 @@ VIPSCore is a part of the [VIPS platform for automatic pest prediction](https://
## Build and deploy
Clone [the code](https://gitlab.nibio.no/VIPS/VIPSCore):
```
$ git clone git@gitlab.nibio.no:VIPS/VIPSCore.git
```
The project includes [maven-wrapper](https://maven.apache.org/wrapper/), which means that you do not need Maven installed locally. Build using the wrapper script with the following command
The project includes [maven-wrapper](https://maven.apache.org/wrapper/), which means that you do not need Maven installed locally. Build using the wrapper script with the following command
```
$ ./mvnw clean install
```
or on Windows
```
$ mvnw.cmd clean install
```
......@@ -30,17 +37,18 @@ $ mvnw.cmd clean install
Download and install [WildFly](https://www.wildfly.org/) >= 25.0.1
Deploy the build from this project in Wildfly.
Deploy the build from this project in Wildfly.
Wildfly should run on Java >= 11
### Adding models
Models are listed as dependencies in the POM and built into the WARfile. In order to make it possible
to configure your own set of models to include, we have separated the model dependencies out in a
separate file. The default is `models.xml`, and contains the models that VIPS in Norway are using
currently.
to configure your own set of models to include, we have separated the model dependencies out in a
separate file. The default is `models.xml`, and contains the models that VIPS in Norway are using
currently.
To build the package with the default set of models, run
To build the package with the default set of models, run
```bash
$ build_with_models.py
......@@ -53,7 +61,9 @@ $ build_with_models.py my_models.xml
```
## Implement a model
See [implement_model.md](./docs/implement_model.md)
## Create client for a model
See [create_client.md](./docs/create_client.md)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment