Ensure consistent headers

kzscisoft · kzscisoft · commit 54e0fc8ef7bc · 2026-06-09T08:45:09.000+01:00
diff --git a/simvue/__init__.py b/simvue/__init__.py
@@ -1,3 +1,11 @@
+"""Simvue Python API.
+
+For interacting with Simvue servers, this includes both a user facing API
+for quick and easy scraping of simulation data, and a lower level API for
+a finer grained interface.
+
+"""
+
 from simvue.client import Client as Client
 from simvue.handler import Handler as Handler
 from simvue.models import RunInput as RunInput
diff --git a/simvue/api/__init__.py b/simvue/api/__init__.py
@@ -1,5 +1,4 @@
 """Simvue API.
-==========
 
 Module contains methods for interacting with a Simvue server
 including accessing/updating objects.
diff --git a/simvue/api/objects/__init__.py b/simvue/api/objects/__init__.py
@@ -1,5 +1,4 @@
 """Simvue API Objects.
-==================
 
 The following module defines objects which provide exact representations
 of information accessible via the Simvue RestAPI, this provides a lower
diff --git a/simvue/api/objects/events.py b/simvue/api/objects/events.py
@@ -1,5 +1,4 @@
 """Simvue Server Events.
-====================
 
 Contains a class for remotely connecting to Simvue events, or defining
 a new set of events given relevant arguments.
diff --git a/simvue/api/objects/folder.py b/simvue/api/objects/folder.py
@@ -1,5 +1,4 @@
 """Simvue Server Folder.
-====================
 
 Contains a class for remotely connecting to a Simvue folder, or defining
 a new folder given relevant arguments.
diff --git a/simvue/api/objects/run.py b/simvue/api/objects/run.py
@@ -1,5 +1,4 @@
 """Simvue Runs.
-===========
 
 Contains a class for remotely connecting to Simvue runs, or defining
 a new run given relevant arguments.
diff --git a/simvue/api/request.py b/simvue/api/request.py
@@ -1,5 +1,4 @@
 """Simvue API Connection.
-=====================
 
 Provides methods for interacting with a Simvue server which include retry
 policies. In cases where JSON is the expected form the data is firstly converted
diff --git a/simvue/api/url.py b/simvue/api/url.py
@@ -1,5 +1,4 @@
 """URL Library.
-===========
 
 Module contains classes for easier handling of URLs.
 
diff --git a/simvue/config/__init__.py b/simvue/config/__init__.py
@@ -1,5 +1,4 @@
 """Simvue Configuration.
-====================
 
 This module contains definitions for the Simvue configuration options
 
diff --git a/simvue/config/files.py b/simvue/config/files.py
@@ -1,5 +1,4 @@
 """Simvue Config File Lists.
-========================
 
 Contains lists of valid Simvue configuration file names.
 
diff --git a/simvue/config/parameters.py b/simvue/config/parameters.py
@@ -1,5 +1,4 @@
 """Simvue Configuration File Models.
-================================
 
 Pydantic models for elements of the Simvue configuration file
 
diff --git a/simvue/config/user.py b/simvue/config/user.py
@@ -1,5 +1,4 @@
 """Simvue Configuration File Model.
-===============================
 
 Pydantic model for the Simvue TOML configuration file
 
diff --git a/simvue/converters.py b/simvue/converters.py
@@ -1,5 +1,4 @@
 """Converter Functions.
-===================
 
 Contains functions for converting objects retrieved from the server between
 data types including creation of DataFrames for metrics
diff --git a/simvue/dispatch/base.py b/simvue/dispatch/base.py
@@ -1,3 +1,5 @@
+"""Dispatcher base class definitions."""
+
 import abc
 import threading
 import typing
diff --git a/simvue/dispatch/direct.py b/simvue/dispatch/direct.py
@@ -1,3 +1,5 @@
+"""Direct dispatcher for instantaneous sending of objects."""
+
 import threading
 import typing
 
diff --git a/simvue/dispatch/queued.py b/simvue/dispatch/queued.py
@@ -1,5 +1,4 @@
 """Queue Dispatcher.
-================
 
 The QueueDispatcher provides a queue based system for execution of a callback on
 a list of parameters. The purpose of the class is to apply constraints to how
diff --git a/simvue/eco/__init__.py b/simvue/eco/__init__.py
@@ -1,5 +1,4 @@
 """Simvue Eco.
-==========
 
 Contains functionality for green IT, monitoring emissions etc.
 NOTE: The metrics calculated by these methods should be used for relative
diff --git a/simvue/eco/api_client.py b/simvue/eco/api_client.py
@@ -1,5 +1,4 @@
 """CO2 Signal API Client.
-=====================
 
 Provides inteface to the CO2 Signal API,
 which provides real-time data on the carbon intensity of
diff --git a/simvue/eco/config.py b/simvue/eco/config.py
@@ -1,5 +1,4 @@
 """Eco Config.
-==========
 
 Configuration file extension for configuring the Simvue Eco sub-module.
 """
diff --git a/simvue/eco/emissions_monitor.py b/simvue/eco/emissions_monitor.py
@@ -1,5 +1,4 @@
 """CO2 Monitor.
-===========
 
 Provides an interface for estimating CO2 usage for processes on the CPU.
 """
diff --git a/simvue/exception.py b/simvue/exception.py
@@ -1,5 +1,4 @@
 """Simvue Exception Types.
-======================
 
 Custom exceptions for handling of Simvue request scenarions.
 
diff --git a/simvue/metadata.py b/simvue/metadata.py
@@ -1,5 +1,4 @@
 """Metadata.
-========
 
 Contains functions for extracting additional metadata about the current project
 
diff --git a/simvue/metrics.py b/simvue/metrics.py
@@ -1,5 +1,4 @@
 """CPU/GPU Metrics.
-===============
 
 Get information relating to the usage of the CPU and GPU (where applicable)
 
diff --git a/simvue/models.py b/simvue/models.py
@@ -1,3 +1,5 @@
+"""Pydantic Validation models for input value checking."""
+
 import datetime
 import typing
 
diff --git a/simvue/serialization.py b/simvue/serialization.py
@@ -1,5 +1,4 @@
 """Object Serialization.
-====================
 
 Contains serializers for storage of objects on the Simvue server
 """
diff --git a/simvue/simvue_types.py b/simvue/simvue_types.py
@@ -1,3 +1,5 @@
+"""Simvue Type objects for Python typing."""
+
 import typing
 
 try:
diff --git a/simvue/system.py b/simvue/system.py
@@ -1,4 +1,4 @@
-"""Retrieve System Information for Metrics."""
+"""Retrieve System Information."""
 
 import contextlib
 import pathlib
diff --git a/simvue/utilities.py b/simvue/utilities.py
@@ -1,3 +1,5 @@
+"""Utility and global helper functions."""
+
 import contextlib
 import functools
 import hashlib
diff --git a/simvue/version.py b/simvue/version.py
@@ -1,3 +1,5 @@
+"""Retrieve current API version."""
+
 import importlib.metadata
 import pathlib
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Simvue API.`
`2`		`-==========`
`3`	`2`
`4`	`3`	`Module contains methods for interacting with a Simvue server`
`5`	`4`	`including accessing/updating objects.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Simvue API Objects.`
`2`		`-==================`
`3`	`2`
`4`	`3`	`The following module defines objects which provide exact representations`
`5`	`4`	`of information accessible via the Simvue RestAPI, this provides a lower`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Simvue Server Events.`
`2`		`-====================`
`3`	`2`
`4`	`3`	`Contains a class for remotely connecting to Simvue events, or defining`
`5`	`4`	`a new set of events given relevant arguments.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Simvue Server Folder.`
`2`		`-====================`
`3`	`2`
`4`	`3`	`Contains a class for remotely connecting to a Simvue folder, or defining`
`5`	`4`	`a new folder given relevant arguments.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Simvue Runs.`
`2`		`-===========`
`3`	`2`
`4`	`3`	`Contains a class for remotely connecting to Simvue runs, or defining`
`5`	`4`	`a new run given relevant arguments.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Simvue API Connection.`
`2`		`-=====================`
`3`	`2`
`4`	`3`	`Provides methods for interacting with a Simvue server which include retry`
`5`	`4`	`policies. In cases where JSON is the expected form the data is firstly converted`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""URL Library.`
`2`		`-===========`
`3`	`2`
`4`	`3`	`Module contains classes for easier handling of URLs.`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Simvue Configuration.`
`2`		`-====================`
`3`	`2`
`4`	`3`	`This module contains definitions for the Simvue configuration options`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Simvue Config File Lists.`
`2`		`-========================`
`3`	`2`
`4`	`3`	`Contains lists of valid Simvue configuration file names.`
`5`	`4`