diff --git a/doc/PID tuning.md b/doc/PID tuning.md index 51abc74..767704c 100644 --- a/doc/PID tuning.md +++ b/doc/PID tuning.md @@ -13,7 +13,7 @@ When tuning Thermostat PID parameters, it is helpful to view the temperature, PI To use the Python real-time plotting utility, run ```shell -python pytec/plot.py +python pythermostat/plot.py ``` ![default view](./assets/default%20view.png) @@ -44,12 +44,12 @@ Below are some general guidelines for manually tuning PID loops. Note that every ## Auto Tuning -A PID auto tuning utility is provided in the Pytec library. The auto tuning utility drives the the load to a controlled oscillation, observes the ultimate gain and oscillation period and calculates a set of PID parameters. +A PID auto tuning utility is provided in the PyThermostat library. The auto tuning utility drives the the load to a controlled oscillation, observes the ultimate gain and oscillation period and calculates a set of PID parameters. To run the auto tuning utility, run ```shell -python pytec/autotune.py +python pythermostat/autotune.py ``` After some time, the auto tuning utility will output the auto tuning results, below is a sample output diff --git a/flake.nix b/flake.nix index a3a0d48..c846d21 100644 --- a/flake.nix +++ b/flake.nix @@ -58,10 +58,10 @@ auditable = false; }; - pytec = pkgs.python3Packages.buildPythonPackage { - pname = "pytec"; + pythermostat = pkgs.python3Packages.buildPythonPackage { + pname = "pythermostat"; version = "0.0.0"; - src = "${self}/pytec"; + src = "${self}/pythermostat"; propagatedBuildInputs = with pkgs.python3Packages; [ @@ -72,7 +72,7 @@ in { packages.x86_64-linux = { - inherit thermostat pytec; + inherit thermostat pythermostat; default = thermostat; }; diff --git a/pytec/autotune.py b/pythermostat/autotune.py similarity index 100% rename from pytec/autotune.py rename to pythermostat/autotune.py diff --git a/pytec/example.py b/pythermostat/example.py similarity index 100% rename from pytec/example.py rename to pythermostat/example.py diff --git a/pytec/plot.py b/pythermostat/plot.py similarity index 100% rename from pytec/plot.py rename to pythermostat/plot.py diff --git a/pytec/pytec/__init__.py b/pythermostat/pythermostat/__init__.py similarity index 100% rename from pytec/pytec/__init__.py rename to pythermostat/pythermostat/__init__.py diff --git a/pytec/pytec/client.py b/pythermostat/pythermostat/client.py similarity index 100% rename from pytec/pytec/client.py rename to pythermostat/pythermostat/client.py diff --git a/pytec/setup.py b/pythermostat/setup.py similarity index 91% rename from pytec/setup.py rename to pythermostat/setup.py index 3a46a57..e1f7c87 100644 --- a/pytec/setup.py +++ b/pythermostat/setup.py @@ -1,7 +1,7 @@ from setuptools import setup, find_packages setup( - name="pytec", + name="pythermostat", version="0.0", author="M-Labs", url="https://git.m-labs.hk/M-Labs/thermostat", diff --git a/pytec/test.py b/pythermostat/test.py similarity index 100% rename from pytec/test.py rename to pythermostat/test.py