Merge pull request #798 from alan-turing-institute/release

Update version

Author: EdwinB12

README.md

@@ -9,6 +9,8 @@
 <!-- SPHINX-START -->
 Simulations of physical systems are often slow and need lots of compute, which makes them unpractical for real-world applications like digital twins, or when they have to run thousands of times for sensitivity analyses. The goal of `AutoEmulate` is to make it easy to replace simulations with fast, accurate emulators. To do this, `AutoEmulate` automatically fits and compares various emulators, ranging from simple models like Radial Basis Functions and Second Order Polynomials to more complex models like Support Vector Machines and  Gaussian Processes to find the best emulator for a simulation. 
 
+>[!WARNING]
+>Although AutoEmulate is currently on version 1.x, we are not following semantic versioning at the moment. The convention for V1 is that breaking and major changes will be made between minor version (1.1 -> 1.2). Bug fixes will be made in patch versions (1.1.1 -> 1.1.2). We plan to implement true semantic versioning in v2 of the package. We recommend pinning the minor version of AutoEmulate if using downstream and carefully reading release notes.
 
 ## Documentation
 

docs/installation.md

@@ -5,6 +5,10 @@ In this section we will describe the main ways to install the package.
 For new users, we recommend installing the package from PyPI.
 For users who want to contribute to the package, we recommend installing the package from source code.
 
+```{warning}
+Although AutoEmulate is currently on version 1.x, we are not following semantic versioning at the moment. The convention for V1 is breaking and major changes will be made between minor version (1.1 -> 1.2). Bug fixes will be made in path versions (1.1.1 -> 1.1.2). We plan to implement true semantic versioning in v2 or the package.  We recommend pinning the minor version of AutoEmulate if using downstream and carefully reading release notes.
+```
+
 ## Prerequisites
 
 **Python Version:** `AutoEmulate` requires Python `>=3.10` and `<3.13`.
@@ -14,7 +18,7 @@ For users who want to contribute to the package, we recommend installing the pac
 To get the latest release from PyPI:
 
 ```bash
-pip install autoemulate
+pip install autoemulate==1.1
 ```
 
 ## Install using UV

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "autoemulate"
-version = "1.0.0"
+version = "1.1.0"
 description = "A python package for semi-automated emulation"
 license = "MIT"
 authors = [{ name = "AutoEmulate contributors (see our GitHub page)" }]