Installation

Since cold is not yet available on PyPI, you need to clone the repository and install it manually.

1. Clone the Repository

   git clone https://github.com/DigiBatt/cold.git
   cd cold
   

2. Create and Activate a Virtual Environment (Recommended)

   python -m venv .venv
   source .venv/bin/activate  # Windows: .venv\Scripts\activate
   

3. Install Dependencies

   pip install --upgrade pip
   pip install -r requirements.txt
   

4. Install cold in Editable Mode

   pip install -e .
   

   This allows you to use cold while making changes to its source code.

5. Autogenerate python classes

   This uses pydantic to create python classes from the ontology models. This needs doing the first time you install cold, and whenever the ontology models change. .. code-block:: sh

   python cold/scripts/regenerate_models.py

6. Verify Installation

   import cold
   print(cold.__version__)  # Check that it works
   

You’re all set to use cold in your projects!