Update README.md

README.md

@@ -1,27 +1,25 @@
 # Scylla Plugin for the SOPA Framework
-This repository contains a plugin for the business process simulation engine [Scylla](https://github.com/bptlab/scylla), extending it by the SOPA framework.
+This repository contains a plugin for the business process simulation engine [Scylla](https://github.com/bptlab/scylla), extending it by the [SOPA framework](http://arxiv.org/abs/2405.01176) for sustainability-oriented process analysis and re-design.
 
-## ℹ️ About
-The plugin works by extending Scylla, a business process simulator, by processing sustainability information
-of a business process, passing it through the Scylla simulation, and outputs data insights.
-### Why is sustainability information important?
-Provides insights into the environmental impact of business processes/activities.
-### What is Cost Driver(CD)?
-Cost Driver is the term used to describe the cost of an activity. Here we abbreviate them into CD. Abstract cost driver (ACD) is a category consuming resource and causes environmental impact. Concrete cost driver (CCD) is the concreteized case of ACD. Take Delivery packages in our life, delivery can be considered as an ACD while delivery by a lorry or bicycle can be its CCD.
-### What is the Cost Variant?
+## ℹ️ Key Concepts
+The plugin extends Scylla with sustainability information of business processes. For details on the framework, have a look at the [respective research paper](http://arxiv.org/abs/2405.01176).
+The resulting simulations provide insights into the environmental impact of business processes and their activities.
+
+### What are Cost Drivers?
+Cost Drivers (CD) describe factors of environmental impact for activities. Abstract cost drivers (ACD) constitute the general categories of cost driver and activity has. Concrete cost drivers (CCD) are the concretized cases of the ACDs. As en example, in an activity "Delivery packages", the method of delivery can be considered as an ACD while delivery by a bicycle can be one of its concretizations.
+
+### What are Cost Variants?
 Cost variants govern what specific combinations of concretizations can occur during individual process instances based on the environmental cost driver hierarchy. In other words, what sets of concrete environmental cost drivers can, during process execution, take the place of the abstract environmental cost drivers during activity execution?
+
 ### What are LCA Scores?
 A quantified score of environmental impacts associated with the life cycle of a commercial product.
-## 🎯Objective
-Whilst the concern for the world’s ecosystem seems to grow, industries need to measure how much their business processes impact the environment. Thus, considering the environmental impacts of business processes has become an important factor that needs to be considered.
-Business process model and notation (BPMN) has been introduced to organizations to allow them to construct models of their business processes. Within this business process exist activities that contain further information about the activity itself.
-Scylla is a BPMN simulator being used in the case, the plugin is an extension of Scylla by dealing with the additional sustainability info.
 
-More information can be found in our [report](https://github.com/INSM-TUM-Teaching/cost_driver/blob/main/Final_Report_scylla_sustainability.pdf).
+
+
 ### 🛠️ How to run it?
 ### [For Developers]
-1. git clone our repository
-2. [Download](https://github.com/bptlab/scylla/releases) and add Scylla.jar and scylla-tests.jar into libs
+1. git clone the repository
+2. [Download Scylla](https://github.com/bptlab/scylla/releases) and add Scylla.jar and scylla-tests.jar into the libs folder
 3. Navigate to src/main/java/cost_driver/Main and run.
 4. Select the desired configuration files in the samples UI and check "cost_driver" as a plugin.
 <img width="1822" alt="Screenshot 2024-01-17 at 23 10 06" src="https://github.com/mhunter02/BearCrow-private/assets/85895529/83200e2f-5fce-4098-8c8e-0b2224d9d91e">
@@ -30,7 +28,7 @@ More information can be found in our [report](https://github.com/INSM-TUM-Teachi
 #### NOTE
 *1. Please remember to put the latest scylla.jar & scylla-tests.jar files in the ./lib folder</br>
 *2. Another way of managing the plugin is by replacing the current Scylla dependencies, with the following. Please ensure you are using the [latest](https://github.com/orgs/bptlab/packages?repo_name=scylla) Scylla package
-```
+```xml
       <dependency>
             <groupId>de.hpi.bpt</groupId>
             <artifactId>scylla</artifactId>
@@ -47,20 +45,18 @@ More information can be found in our [report](https://github.com/INSM-TUM-Teachi
 ```
 
 ### [For users]
-1. Download the latest version of [scylla.zip](https://github.com/bptlab/scylla/releases)
-2. Download our plugin package [cost_driver.zip](https://github.com/INSM-TUM-Teaching/cost_driver/releases/tag/0.0.1-SNAPSHOT)
-3. Unzip them
-4. Create a directory "samples" under Scylla and put desired samples in
-5. Double click scylla.jar and obtain the UI as step 4 above
-
+1. Download and unzip the latest version of [scylla.zip](https://github.com/bptlab/scylla/releases)
+2. Download our plugin package jarfile [here](https://github.com/INSM-TUM/Scylla-Plugin--SOPA/releases/latest) and put it into scylla's plugin folder
+3. Start Scylla
+
 A demo video can be found [here](https://youtu.be/ag2_OvQh5vY).
 
 ## 🧱 Components
-Three Plugins are cooperating to achieve this.
+Threep plugin classes are cooperating to achieve this.
 
 ### Global Configuration Parser Plugin
 Parses the global config file which describes the abstract CDs and their children, concreteCDs with details that it consists of:
-```ruby
+```xml
 <bsim:costDriver>
     <bsim:abstractCostDriver id="[Abstract Cost Driver ID]">
       <bsim:concreteCostDeiver id="[Concrete Cost Driver ID]" cost="[LCA Score]"/>
@@ -72,10 +68,10 @@ Parses the global config file which describes the abstract CDs and their childre
 ```
 ### Simulation Configuration Parser Plugin
 Parses the simulation config file which describes the cost variant by ID, frequency of occurrence, and cost:
-```ruby
+```xml
 <bsim:costVariantConfig>
       <bsim:variant id="[Cost Variant ID]" frequency="[double]">
-        <bsim:driver id="[Abstract Cost Driver ID]" cost="[Cost]"/>
+        <bsim:driver absractId="[Abstract Cost Driver ID]" concreteId="[Concrete Cost Driver ID]"/>
       </bsim:variant>
 ```
 ### Logger Plugin
@@ -85,7 +81,7 @@ Logs the extended simulation data as an XES and XML file.
 The results will be shown in two files, *.xes and *_statistic.xml. 
 ### Event log (enclosed with .xes)
 The event log is composed of a sequence of activity instances. We put the activity cost, process cost reference Abstract Cost Driver, and Concrete Cost Driver inside so that the utilization of resources used is clear.
-```ruby
+```xml
 <trace>
 	<string key="concept:name" value="cost[Process_Instance_ID]"/>
 	<string key="cost:Process_Instance" value="[Total Cost]"/>
@@ -104,7 +100,7 @@ The event log is composed of a sequence of activity instances. We put the activi
 ### Aggregated sustainability information (enclosed with _statistic.xml)
 The outputted file shows a complete detailed breakdown of sustainability info.
 Explanation of nodes moving downwards:
-```ruby
+```xml
 <Sustainability_Info>
     <Average_Cost_Variant_Cost id="[id]">[cost]</Average_Cost_Variant_Cost>
     ...
@@ -133,4 +129,3 @@ Explanation of nodes moving downwards:
 ## References: <br>
 Pufahl, L., & Weske, M. (January 2018). Design of an Extensible BPMN Process Simulator. Retrieved from https://www.researchgate.net/publication/322524759_Design_of_an_Extensible_BPMN_Process_Simulator?enrichId=rgreq-55dc4561329b473ce8f8871f05e56dba-XXX&enrichSource=Y292ZXJQYWdlOzMyMjUyNDc1OTtBUzo1OTU2ODQ2MDQ1MjY1OTJAMTUxOTAzMzY4NTAwNg%3D%3D&el=1_x_3&_esc=publicationCoverPdf  <br>
 Ng, K. Y. (1996). An Algorithm for Acyclic State Machines. *Acta Informatica*, 33(4), 223–228. https://doi.org/10.1007/BF02986351
-