Rename script to snake_case, update Dockerfile/README, slim .gitignore

- CPULoadGenerator.py -> cpu_load_generator.py (PEP 8 module name)
- Dockerfile: python:3.13, LABEL maintainer, MAINTAINER removed
- README: cpu_load_generator.py in all examples
- .gitignore: project-focused (Python, IDE, generated PNG), drop C#/C++/Java template

Made-with: Cursor

Author: GaetanoCarlucci

.gitignore

@@ -1,219 +1,31 @@
-*.jpg
-*.png
-
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/dictionaries
-.idea/**/shelf
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
-.idea/**/gradle.xml
-.idea/**/libraries
-cmake-build-debug/
-cmake-build-release/
-.idea/**/mongoSettings.xml
-*.iws
-out/
-.idea_modules/
-atlassian-ide-plugin.xml
-.idea/replstate.xml
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-.idea/httpRequests
-*.suo
-*.user
-*.userosscache
-*.sln.docstates
-*.userprefs
-[Dd]ebug/
-[Dd]ebugPublic/
-[Rr]elease/
-[Rr]eleases/
-x64/
-x86/
-bld/
-[Bb]in/
-[Oo]bj/
-[Ll]og/
-.vs/
-Generated\ Files/
-[Tt]est[Rr]esult*/
-[Bb]uild[Ll]og.*
-*.VisualState.xml
-TestResult.xml
-[Dd]ebugPS/
-[Rr]eleasePS/
-dlldata.c
-BenchmarkDotNet.Artifacts/
-project.lock.json
-project.fragment.lock.json
-artifacts/
-StyleCopReport.xml
-*_i.c
-*_p.c
-*_i.h
-*.ilk
-*.meta
-*.obj
-*.iobj
-*.pch
-*.pdb
-*.ipdb
-*.pgc
-*.pgd
-*.rsp
-*.sbr
-*.tlb
-*.tli
-*.tlh
-*.tmp
-*.tmp_proj
-*.log
-*.vspscc
-*.vssscc
-.builds
-*.pidb
-*.svclog
-*.scc
-_Chutzpah*
-ipch/
-*.aps
-*.ncb
-*.opendb
-*.opensdf
-*.sdf
-*.cachefile
-*.VC.db
-*.VC.VC.opendb
-*.psess
-*.vsp
-*.vspx
-*.sap
-*.e2e
-$tf/
-*.gpState
-_ReSharper*/
-*.[Rr]e[Ss]harper
-*.DotSettings.user
-.JustCode
-_TeamCity*
-*.dotCover
-.axoCover/*
-!.axoCover/settings.json
-*.coverage
-*.coveragexml
-_NCrunch_*
-.*crunch*.local.xml
-nCrunchTemp_*
-*.mm.*
-AutoTest.Net/
-.sass-cache/
-[Ee]xpress/
-DocProject/buildhelp/
-DocProject/Help/*.HxT
-DocProject/Help/*.HxC
-DocProject/Help/*.hhc
-DocProject/Help/*.hhk
-DocProject/Help/*.hhp
-DocProject/Help/Html2
-DocProject/Help/html
-publish/
-*.[Pp]ublish.xml
-*.azurePubxml
-*.pubxml
-*.publishproj
-PublishScripts/
-*.nupkg
-**/[Pp]ackages/*
-!**/[Pp]ackages/build/
-*.nuget.props
-*.nuget.targets
-csx/
-*.build.csdef
-ecf/
-rcf/
-AppPackages/
-BundleArtifacts/
-Package.StoreAssociation.xml
-_pkginfo.txt
-*.appx
-*.[Cc]ache
-!*.[Cc]ache/
-ClientBin/
-~$*
-*~
-*.dbmdl
-*.dbproj.schemaview
-*.jfm
-*.pfx
-*.publishsettings
-orleans.codegen.cs
-Generated_Code/
-_UpgradeReport_Files/
-Backup*/
-UpgradeLog*.XML
-UpgradeLog*.htm
-ServiceFabricBackup/
-*.rptproj.bak
-*.mdf
-*.ldf
-*.ndf
-*.rdl.data
-*.bim.layout
-*.bim_*.settings
-*.rptproj.rsuser
-FakesAssemblies/
-*.GhostDoc.xml
-.ntvs_analysis.dat
-node_modules/
-*.plg
-*.opt
-*.vbw
-**/*.HTMLClient/GeneratedArtifacts
-**/*.DesktopClient/GeneratedArtifacts
-**/*.DesktopClient/ModelManifest.xml
-**/*.Server/GeneratedArtifacts
-**/*.Server/ModelManifest.xml
-_Pvt_Extensions
-.paket/paket.exe
-paket-files/
-.fake/
-.idea/
-*.sln.iml
-.cr/
+# Python
 __pycache__/
-*.pyc
-*.tss
-*.jmconfig
-*.btp.cs
-*.btm.cs
-*.odx.cs
-*.xsd.cs
-OpenCover/
-ASALocalRun/
-*.binlog
-*.nvuser
-.mfractor/
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
+*.py[cod]
+*$py.class
+*.so
 .Python
-[Bb]in
-[Ii]nclude
-[Ll]ib
-[Ll]ib64
-[Ll]ocal
-[Ss]cripts
-pyvenv.cfg
-.venv
-pip-selfcheck.json
 venv/
+.venv/
+.env
+*.egg-info/
+.eggs/
+dist/
+build/
+
+# Generated plot outputs (script saves PNG with --plot)
+*.png
+*.jpg
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Jekyll / GitHub Pages (optional: if you build locally)
+_site/
+.jekyll-cache/

Dockerfile

@@ -1,10 +1,10 @@
-FROM python:3.6
-MAINTAINER GaetanoCarlucci <gaetano.carlucci@gmail.com>
+FROM python:3.13
+LABEL maintainer="GaetanoCarlucci <gaetano.carlucci@gmail.com>"
 
 RUN apt-get update -q && apt-get install git && apt-get clean
 RUN cd / && git clone https://github.com/GaetanoCarlucci/CPULoadGenerator.git /CPULoadGenerator
 RUN pip install -r /CPULoadGenerator/requirements.txt
 
 WORKDIR /CPULoadGenerator
-ENTRYPOINT ["./CPULoadGenerator.py"]
+ENTRYPOINT ["./cpu_load_generator.py"]
 CMD ["--help"]

README.md

@@ -34,10 +34,10 @@ pip install -r requirements.txt
 Run the script (e.g. 20% load on core 0 for 10 seconds):
 
 ```bash
-python CPULoadGenerator.py -l 0.2 -d 10 -c 0
+python cpu_load_generator.py -l 0.2 -d 10 -c 0
 ```
 
-Or make the script executable and run: `chmod +x CPULoadGenerator.py` then `./CPULoadGenerator.py -l 0.2 -d 10 -c 0`.
+Or make the script executable and run: `chmod +x cpu_load_generator.py` then `./cpu_load_generator.py -l 0.2 -d 10 -c 0`.
 
 **System-wide install (Debian/Ubuntu):** `sudo apt install python3-matplotlib python3-psutil python3-click`
 
@@ -48,25 +48,25 @@ Or make the script executable and run: `chmod +x CPULoadGenerator.py` then `./CP
 1. **20% load on core 0 for 20 seconds:**
 
    ```bash
-   ./CPULoadGenerator.py -l 0.2 -d 20 -c 0
+   ./cpu_load_generator.py -l 0.2 -d 20 -c 0
    ```
 
 2. **65% load on cores 0, 1 and 5, until interrupted (Ctrl-C):**
 
    ```bash
-   ./CPULoadGenerator.py -l 0.65 -c 0 -c 1 -c 5
+   ./cpu_load_generator.py -l 0.65 -c 0 -c 1 -c 5
    ```
 
 3. **55% load on core 0, 12% on core 3, until interrupted:**
 
    ```bash
-   ./CPULoadGenerator.py -c 0 -c 3 -l 0.55 -l 0.12
+   ./cpu_load_generator.py -c 0 -c 3 -l 0.55 -l 0.12
    ```
 
 4. **12% load on cores 0 and 1 for 20.5 seconds, then plot the load:**
 
    ```bash
-   ./CPULoadGenerator.py -l 0.12 -c 0 -c 1 -d 20.5 --plot
+   ./cpu_load_generator.py -l 0.12 -c 0 -c 1 -d 20.5 --plot
    ```
 
 5. **Example graph of CPU load (50% target on core 0):**

CPULoadGenerator.py cpu_load_generator.pyCPULoadGenerator.py renamed to cpu_load_generator.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+"""Generate a fixed CPU load on one or more cores using a PI controller."""
 
 # Authors: Gaetano Carlucci
 #         Giuseppe Cofano
@@ -37,7 +38,7 @@ def _set_cpu_affinity(core_id):
 
 
 class ShutdownException(Exception):
-    pass
+    """Raised on SIGINT/SIGTERM to trigger graceful shutdown of load generation."""
 
 
 def __sig_handler(*args):
@@ -47,6 +48,7 @@ def __sig_handler(*args):
 def load_core(target_core, target_load,
               duration_seconds=-1, plot=False,
               sampling_interval=0.1):
+    """Run the PI-controlled load generator on a single CPU core."""
     if duration_seconds >= 0:
         print(f'Loading core {target_core} ({target_load * 100.0:0>5.2f}%) for '
               f'{duration_seconds} seconds.')
@@ -55,8 +57,7 @@ def load_core(target_core, target_load,
               f'until interrupted.')
 
     if sampling_interval <= 0:
-        raise Exception('Negative sampling interval!')
-
+        raise ValueError('Negative sampling interval!')
     # Lock this process to the target core (no-op on macOS; load still applied)
     _set_cpu_affinity(target_core)