irdc-ccsk
Java implementation of distributed reversible computation verification
Science Score: 65.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
✓Institutional organization owner
Organization cinrc has institutional domain (spots.augusta.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.1%) to scientific vocabulary
Keywords
Repository
Java implementation of distributed reversible computation verification
Basic Info
- Host: GitHub
- Owner: CinRC
- License: gpl-3.0
- Language: Java
- Default Branch: master
- Homepage: https://spots.augusta.edu/caubert/cinrc/
- Size: 550 KB
Statistics
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 11
- Releases: 7
Topics
Metadata Files
README.md
Implementation of Reversible Distributed Calculus (CCSK)
What is RCCS/CCSK?
The Reversible Calculus of Communicating Systems (RCCS) and the Calculus of Communicating Systems with Keys (CCSK) are two formal languages that describes the interaction of concurrent systems in a reversible paradigm. They are both described in Static versus dynamic reversibility in CCS (doi:10.1007/s00236-019-00346-6), and shown to be equivalent (in terms of labelled transition system isomorphism) in the same paper.
What is this project?
This project is the first to publicly available implementation a functional formal language (in this case, inspired by CCSK) that models concurrent reversible systems. At its core, this is a parser and evaluation tool. The program takes user input in the form of CCS processes (using the syntax specified below) and parses, tokenizes, and traverses it at the user's will (using CSSK's labelled transition system, described and exemplified in this documentation).
Everything in this program is original, including string traversal libraries and GUI. It is currently developed in the School of Computer and Cyber Sciences, primarily by Peter Browning and Dr.Clément Aubert. Please, refer to our list of contributors for an up-to-date list of contributors.
Getting Started
Use-Only
You will need the Java Runtime Environment (JRE) (≥8) to execute this program. Download the .jar file in our latest release, potentially using this simple one-liner[^1]: [^1]: Inspired by https://gist.github.com/steinwaywhw/a4cd19cda655b8249d908261a62687f8.
curl -s https://api.github.com/repos/CinRC/IRDC-CCSK/releases/latest \
| grep browser_download_url \
| cut -d : -f 2,3 \
| tr -d \" \
| wget -qi -
Then execute e.g., the process $((a+b) | \overline{b}) | \overline{a}) \backslash a$ using
java -jar IRDC-*.jar "(((a+b) |'b)|'a)\{a}"
To run with a GUI, use the --gui flag. Else, a command-line-interface will open instead, you can use it with:
java -jar IRDC-*.jar <FLAGS> "[Process]"
Some examples of processes are indicated in docs/example_processes.md if you need inspiration.
The flags are documented below.
Building
You will need Maven (≥3.0) and the Java Development Kit (≥17) to compile this program. Some of the possible phases are:
mvn packageto build from source (the executable will be in thetarget/folder),mvn validateto test for checkstyle violations (we use google_checks.xml),mvn testto run our pre-written unit tests (gathered in thesrc/test/javafolder) that are designed to represent difficult a diverse range of different scenarios.
To run e.g., all the test methods whose name starts with simulationIsStructural in the tests.SimulationTest class,
use
mvn -Dtest="tests.SimulationTest#simulationIsStructural*" test
Contributing
We are thrilled that you consider contributing to our project. Please refer to our contributing guidelines.
Additional Information
Developer slang
Some parts of this program are named different from the convention. Some of the notable ones are are listed below:
- Channel names are referred to as 'Labels'
- Parallel operators (
|) are referred to as 'Concurrent Processes' - Deterministic operators (
+) are referred to as 'Summation Processes' - CCSK keys (
a[k0].P) are referred to as 'Label Keys'
Syntax and Precedence of Operators
This program follows a slightly modified semantic structure based off of CCSK. Some notes are included below.
- By default, all labels are given implicit null processes (
ais implied to representa.0). This is toggleable using the--require-explicit-nullflag. - Channel labels are limited to lowercase english letters
[a-z]. - Complement channels are represented by an apostrophe before the label,
'a,'b, etc. - Process names are limited to uppercase english letters
[A-Z]. We assume that all channels sharing the same label are complements. This means that
'ais the complement toa,'btob, and so forth.Restrictions are applied under the following format:
a.P\{a,b,c}.We assume that the operators have decreasing binding power, in the following order:
\a,a.,|,+.- This means that
a|b\{a}will be interpreted as(a)|(b\{a}). - More specifically,
a.a + b | c \{a}is to be read as(a.a) + (b | (c\a))(infix notation) or+ . a a | b \a c(postfix notation). - Of course, parenthesis take precedence over all operators.
- Redundant parenthesis are permitted, e.g.,
(((a)|(b)))will be accepted but interpreted as(a|b).
- This means that
Command arguments (flags)
This program can be configured by using command-line arguments, or flags. The flags are as follows:
| Flag | Description | |-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --debug | Enables debug mode. Will print info to stdout | | --help | Prints help message documenting flags | | --dL | Labels are visibly differentiated by integers | | --hide-keys | CCSK keys are hidden | | --sA | Alternative display mode for summation processes. Reversible summations are not annotated | | --process-names-equivalent | Processes names will be treated as being equivalent (P == Q) | | --sC | Alternative display mode for summation processes. Reversible summations are hidden after execution | | --require-explicit-null | Labels explicitly require a trailing process. Labels will no longer have an implicit null process attached | | --hP | Parenthesis surrounding complex processes will be omitted | | --dN | Null processes will be displayed explicitly | | --iU | Parser will ignore unrecognized characters in the process formula | | --kL | (Deprecated) Keys will be visibly similar to the label they represent | | --gui | Program will start with a GUI instead of CLI | | --forward-only | Program will run in a non-reversible paradigm | | --interactive | Run the program in interactive mode. In interactive mode, the given process will be displayed and the user will be prompted to give a label or key to act on. | | --enumerate | Run the program in enumeration mode (Default). In enumeration mode, the given process will be enumerated to completion, and the transition tree will be printed to stdout | | --validate | Run the program in validation mode. In validation mode, a user inputted file will be scanned for processes to parse. Processes in the file must be separated by newlines, with one process per line. Each process will be validated for syntax and formatting. | | --equivalence | Run the program in equivalence mode. In equivalence mode, your input will be in the form of a list of processes separated by commas (,). All equivalence relationships between the given processes will be printed. | | --regenerate | Run the program in regeneration mode. In regeneration mode, you may input a process that has already begun execution. It will then regenerate to its ancestor process and enumerate. |
Contributing
If you'd like to contribute to this project, please refer to the CONTRIBUTING.md file
Versioning
When contributing, the project version must be appropriately incremented inside the pom.xml file. We use a semantic
Maj.Min.Patch.Rev system, where:
- Maj = Major feature or system overhaul
- Min = Feature addition
- Patch = Bug fix
- Rev = Revision (code cleanup, minor edits)
When making changes, increment the version number according to changes made.
Alternatives
This project, in particular, is a working implementation of the Calculus of Communicating Systems with Keys (CCSk). Some of the other implementations of process algebras that are publicly available are:
- This student project,
- The Concurrency Workbench, Aalborg Edition,
- This implementation of HOcore, an intermediate languages between CSS and the π-calculus.
- muccs, an implementation of CCS in Prolog with some nice examples.
- CCS_Prolog, an interpreter for CCS language written in SWI-Prolog.
The implementation of CCSk described in this master thesis is to our knowledge not publicly available.
Owner
- Name: Concurrency In Reversible Computations
- Login: CinRC
- Kind: organization
- Email: caubert@augusta.edu
- Website: https://spots.augusta.edu/caubert/cinrc/
- Repositories: 2
- Profile: https://github.com/CinRC
An NSF-funded project aiming at improving current specification languages for concurrent, reversible programs and protocols.
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Aubert" given-names: "Clément" orcid: "https://orcid.org/0000-0001-6346-3043" - family-names: "Browning" given-names: "Peter" title: "Implementation of Reversible Distributed Calculus (CCSK)" version: 2.0.0 date-released: 2022-12-09 url: "https://github.com/CinRC/IRDC-CCSK/"
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Issues and Pull Requests
Last synced: over 1 year ago
All Time
- Total issues: 81
- Total pull requests: 54
- Average time to close issues: 2 months
- Average time to close pull requests: 7 days
- Total issue authors: 2
- Total pull request authors: 3
- Average comments per issue: 2.38
- Average comments per pull request: 0.27
- Merged pull requests: 52
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- aubertc (53)
- peterbro1 (1)
Pull Request Authors
- peterbro1 (23)
- aubertc (4)
- brettwilliams16 (2)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/cache v1 composite
- actions/checkout v2 composite
- actions/create-release v1 composite
- actions/setup-java v1 composite
- actions/upload-artifact v2 composite
- actions/upload-release-asset v1 composite
- redis * docker
- com.dlsc.formsfx:formsfx-core 11.3.2
- com.gluonhq:charm-glisten 6.1.1
- org.controlsfx:controlsfx 11.1.0
- org.kordamp.bootstrapfx:bootstrapfx-core 0.4.0
- org.openjfx:javafx-controls 17.0.0.1
- org.openjfx:javafx-fxml 17.0.0.1
- org.junit.jupiter:junit-jupiter 5.8.2 test