| Branch | Current Version |
|---|---|
| Main | 1.0.0-SNAPSHOT |
| Develop | 2.0.0-SNAPSHOT |
Bigellor is a web-based modelling tool to graphically create and visualize bigraphs.
The underlying web development framework of Bigellor is a combination of Spring framework and Thymeleaf,
and Cytoscape.js for the visualization of bigraphs in the browser.
Requirements
- Java 17
- Maven 3.8.3 (minimum)
- (Optional) Eclipse CDO Explorer to view and modify the bigraphs directly in the database
-
- Download a CDO Explorer via the Eclipse Installer Use Eclipse Version 2022-12 (4.26.0), which supports CDO protocol version 48. Eclipse IDE version 2023-09 supports only CDO protocol version 49.
-
- Any Eclipse IDE with CDO support, must support CDO protocol version 48
-
The following command must be executed from the root directory of this project:
mvn clean package -DskipTestsAfter the command successfully finishes, the executable application can be found in the directory dist/
from the root of this project.
Note: Ensure that there is read/write permission on the directory, where Bigellor is started.
After the above command successfully finished, you can start using Bigellor.
Therefore, execute the following commands:
cd ./dist/
java -jar bigellor-starter-1.0.0-SNAPSHOT-exec.jarThen, just open the web browser and navigate to http://localhost:8080.
The correct server name and port will be displayed in the console if defaults were changed.
Properties can be configured when starting Bigellor in the following way:
java -jar bigellor-1.0.0-SNAPSHOT-exec.jar --PROPERTY=VALUE --PROPERTY2=VALUE2 ...| Properties | Description |
|---|---|
bigellor.gen-test-data |
(Optional) true or false. If true then a demo signature will be provided in data/signatures/ and available in the IDE. |
bigellor.model.storage.location |
(Optional) A relative folder path. It denotes the storage directory for all user-uploaded model files in Bigellor. |
server.port |
(Optional) A port number. This determines the server port of Bigellor. Default is 8080. |
bigellor.cdo.config |
(Optional) A relative folder path to the Eclipse CDO database configuration file (usually located at config/cdo-server.xml). A default one is provided. |
Eclipse CDO is used as database for all bigraphical model files.
(Note that the model files are currently also persisted on the filesystem.)
The server boots in the background when Bigellor is started; the database uses the folder data/ relative to the application for persistence.
To access Eclipse CDO in Bigellor conveniently the Spring-way (via repositories), the framework Spring Data CDO is used.
An example of the default database configuration properties can be found here: src/main/resources/config/cdo-server.xml.
When Bigellor is build from source, the application can be found in the dist/ folder from the root of this project.
Included is also the config/cdo-server.xml, which can be configured afterwards.
In case you are getting an error while building the project similar to
Fatal error compiling: error: invalid target release: 17
check the JDK for Maven with mvn --version:
$ mvn --version
Apache Maven 3.9.5
Maven home: /opt/maven
Java version: 11.0.20.1In this example, Maven version 3.9.5 uses the JDK 11.
However, JDK 17 is required for this project (see Requirements).
It helps to correct the JAVA_HOME environment variable.
Bigellor is Open Source software released under the Apache 2.0 license.
Copyright 2023-present Dominik Grzelak
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.