ITA Controlled English (CE)
The CE Store contains everything you need to get started with the ITA Controlled English environment.
We are an IBM initiated open source organisation focused on providing an experimental research environment for the ITA Controlled English language.
Quick Guide
- Installation and Setup
- Usage
- Tutorials
- API
- Cheatsheet
- Command Syntax
- Hudson
- Other Projects
- Contributing
- License
Deploy To Bluemix
Installation and Setup
Clone the code
git clone https://github.com/ce-store/ce-store
Using Apache Maven
Using Apache Maven, run the following command to start up the CE Store application using an embedded Tomcat server.
mvn install
mvn tomcat:run
The CE Store will be available at the following URL http://localhost:8080/ce-store
Using Docker
docker pull cestore/ce-store
docker run --rm -it -p 8080:8080 cestore/ce-store
Building With Docker
Use Apache Maven to build a WAR file for the project with the following command.
mvn package
This WAR file can be built into a Docker image with the command below.
docker build -t ce-store .
Then start the container from this image running locally.
docker run --rm -it -p 8080:8080 ce-store
The CE Store will be available at the following URL http://localhost:8080/ce-store
Using Vagrant
Requires Vagrant to be installed.
vagrant up
vagrant ssh
cd /vagrant
Then follow the steps in Using Apache Maven.
Usage
Engineering Panel
The Engineering Panel provides a simple web interface to the CE Store, enabling the user view the contents of the CE Store, to load new CE sentences, run queries agains the store, and more.
To open the Engineering Panel go to <SERVER>/ce-store/ui. It should look like this:
The engineering panel has four main areas:
- [Left] Model operations: CE models can be loaded and modified.
- [Right] Object pane: Contents of a CE store can be viewed.
- [Bottom] Messages: Errors will be reported here
- [Centre] Working area: Interactions with the model.
The CE Store comes with a sample set of CE sentences to build a model about medical data. The wiki includes a tutorial for using the Medicine model.
Contributing
Read about contributing here.
License
Licensed under the Apache License, Version 2.0