Chaos4cps

This repository is for the chaos4cps asset.

Getting Started

1. Clone the Git Repository

First, generate a personal access token (referred to as TOKEN_GENERATED) and replace it in the command below. Also, replace username with your actual username:

git clone https://username:TOKEN_GENERATED@git.cetic.be/carapace/chaoscps.git

2. Setup

This section provides the steps to install chaoscps.

Access folder

cd chaoscps

Create a .env File

Create a .env file in the chaoscps directory and add the following content (modify the variables accordingly):

DB_NAME=DATABASE_NAME
DB_USER=USERNAME_DB
DB_PASSWORD=USERNAME_PASSWORD
# Use 'db' if running with Docker, or 'localhost' if running without Docker
DB_HOST=localhost
DB_PORT=POSTGRES_PORT
# Django Superuser Credentials
DJANGO_SUPERUSER_USERNAME=DJANGO_SUPERUSER_USERNAME
DJANGO_SUPERUSER_EMAIL=DJANGO_SUPERUSER_EMAIL
DJANGO_SUPERUSER_PASSWORD=DJANGO_SUPERUSER_PASSWORD

Running with Docker Compose

Ensure Docker and Docker Compose are installed on your system. Then, run:

docker compose up -d

This command will build and start the required services in detached mode.

Running without Docker Compose

To run the project without Docker, follow these steps:

Install Dependencies

Ensure you have Python installed, then run:

pip install -r requirements.txt

Apply Migrations

Run the following command to apply database migrations:

python manage.py migrate

Create superuser

Run the following command to create a superuser:

python manage.py createsuperuser

Start the Server

Launch the Django application:

python manage.py runserver

2. Screenshots of the application

The application will be accessible at http://127.0.0.1:8000/ by default.

Example of CEAgent (Ai Agent to help SMEs define components, steady states, hypotheses, and experiments)

Example of report generated by ChaosCPS

Generate pdf from .md

npx --yes md-to-pdf USER_GUIDE.md