feat(package): renames the package to stable-learning-control (#257)

This commit renames the package to `stable-learning-control` since this better represents what it
does.

BREAKING CHANGE: The package should now be used as `stable_learning_control` instead of
`bayesian_learning_control`.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
 blank_issues_enabled: true
 contact_links:
   - name: Question
-    url: https://github.com/rickstaa/bayesian-learning-control/discussions
+    url: https://github.com/rickstaa/stable-learning-control/discussions
     about: Please ask and answer questions here.

.github/workflows/release_please.yml

@@ -1,6 +1,6 @@
 # Github action that uses the 'release-please' tool to update the version, changelog
 # and create new releases.
-name: Bayesian Learning Control release
+name: Stable Learning Control release
 on:
   push:
     branches:

.github/workflows/bayesian_learning_control.yml → .github/workflows/stable_learning_control.yml

@@ -1,5 +1,5 @@
 # Runs tests after a pull request is merged.
-name: Bayesian Learning Control
+name: Stable Learning Control
 on:
   push:
     branches:
@@ -41,7 +41,7 @@ jobs:
           python-version: 3.8
           cache: "pip"
           cache-dependency-path: pyproject.toml
-      - name: Install the bayesian_learning_control package with its dependencies
+      - name: Install the stable_learning_control package with its dependencies
         run: |
           pip install -e .[dev]
       - name: flake8 Lint
@@ -58,7 +58,7 @@ jobs:
       matrix:
         python-version: [3.8, 3.9, "3.10"] # Supported python versions
     steps:
-      - name: Checkout bayesian-learning-control repository
+      - name: Checkout stable-learning-control repository
         uses: actions/checkout@v3
       - name: Install system dependencies
         run: sudo apt-get update; sudo apt-get install libopenmpi-dev
@@ -68,7 +68,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
           cache-dependency-path: pyproject.toml
-      - name: Install the bayesian_learning_control package with its dependencies
+      - name: Install the stable_learning_control package with its dependencies
         run: |
           pip install -e .[dev]
       - name: Test with Pytest

.github/workflows/test.yml

@@ -59,7 +59,7 @@ jobs:
           python-version: 3.8
           cache: "pip"
           cache-dependency-path: pyproject.toml
-      - name: Install the bayesian_learning_control package with its dependencies
+      - name: Install the stable_learning_control package with its dependencies
         run: |
           pip install -e .[dev]
       - name: flake8 Lint
@@ -78,7 +78,7 @@ jobs:
       matrix:
         python-version: [3.8, 3.9, "3.10"] # Supported python versions
     steps:
-      - name: Checkout bayesian-learning-control repository
+      - name: Checkout stable-learning-control repository
         uses: actions/checkout@v3
       - name: Install system dependencies
         run: sudo apt-get update; sudo apt-get install libopenmpi-dev
@@ -88,7 +88,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
           cache: "pip"
           cache-dependency-path: pyproject.toml
-      - name: Install the bayesian_learning_control package with its dependencies
+      - name: Install the stable_learning_control package with its dependencies
         run: |
           pip install -e .[dev]
       - name: Test with Pytest

CONTRIBUTING.md

@@ -4,10 +4,10 @@
 
 We love your input! 🚀 We want to make contributing to this project as easy and transparent as possible, whether it's:
 
-*   [Reporting a bug](https://github.com/rickstaa/bayesian-learning-control/issues).
-*   [Discussing the current state of the code](https://github.com/rickstaa/bayesian-learning-control/discussions).
-*   [Submitting a fix](https://github.com/rickstaa/bayesian-learning-control/pulls).
-*   [Proposing new features](https://github.com/rickstaa/bayesian-learning-control/issues).
+*   [Reporting a bug](https://github.com/rickstaa/stable-learning-control/issues).
+*   [Discussing the current state of the code](https://github.com/rickstaa/stable-learning-control/discussions).
+*   [Submitting a fix](https://github.com/rickstaa/stable-learning-control/pulls).
+*   [Proposing new features](https://github.com/rickstaa/stable-learning-control/issues).
 *   Becoming a maintainer.
 
 ## We Develop with Github
@@ -28,13 +28,13 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 6.  Make sure your code lints.
 7.  Commit your changes.
 8.  Create a pull request to pull the changes of your development branch onto the `main` branch.
-9.  Ensure that all the [pull request checks](https://github.com/rickstaa/bayesian-learning-control/actions) were successful.
+9.  Ensure that all the [pull request checks](https://github.com/rickstaa/stable-learning-control/actions) were successful.
 
-### Report bugs using Github's [issues](https://github.com/rickstaa/bayesian-learning-control/issues)
+### Report bugs using Github's [issues](https://github.com/rickstaa/stable-learning-control/issues)
 
 <!--alex ignore easy-->
 
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/rickstaa/bayesian-learning-control/issues/new/choose); it's that easy!
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/rickstaa/stable-learning-control/issues/new/choose); it's that easy!
 
 #### Write bug reports with detail, background, and sample code
 
@@ -73,11 +73,11 @@ We use several language guidelines to increase code quality, readability, and us
 
 ## GitHub actions
 
-The [Bayesian Learning Control](https://github.com/rickstaa/bayesian-learning-control) package contains several [GitHub actions](https://github.com/rickstaa/bayesian-learning-control/actions), which check code changes against the language guidelines above. As a result, when the above guidelines are not met, you will receive an **error/warning** when you create a pull request. Some of these actions will make pull requests which you can use to fix some of these violations. For other **errors/warnings**, you are expected to handle them yourself before merging them into the main branch. If you think a coding guideline needs to be corrected or your code structure doesn't allow you to respect the guideline, please state so in the pull request.
+The [Stable Learning Control](https://github.com/rickstaa/stable-learning-control) package contains several [GitHub actions](https://github.com/rickstaa/stable-learning-control/actions), which check code changes against the language guidelines above. As a result, when the above guidelines are not met, you will receive an **error/warning** when you create a pull request. Some of these actions will make pull requests which you can use to fix some of these violations. For other **errors/warnings**, you are expected to handle them yourself before merging them into the main branch. If you think a coding guideline needs to be corrected or your code structure doesn't allow you to respect the guideline, please state so in the pull request.
 
 ## Pre-commit hooks
 
-The [Bayesian Learning Control](https://github.com/rickstaa/bayesian-learning-control) package also contains several pre-commit hooks that enforce the guidelines above before committing. To enable these hooks, please:
+The [Stable Learning Control](https://github.com/rickstaa/stable-learning-control) package also contains several pre-commit hooks that enforce the guidelines above before committing. To enable these hooks, please:
 
 1.  Install [node](https://nodejs.org/en/download/package-manager).
 2.  Install [python](https://www.python.org/downloads).
@@ -89,7 +89,7 @@ Releases are handled automatically by the [release-please-action](https://github
 
 ## Documentation guidelines
 
-See the [documentation guidelines](https://rickstaa.dev/bayesian-learning-control/dev/doc_dev.html) for more information on contributing to the documentation.
+See the [documentation guidelines](https://rickstaa.dev/stable-learning-control/dev/doc_dev.html) for more information on contributing to the documentation.
 
 ## Any contributions you make will be under the MIT Software License
 

README.md

@@ -1,18 +1,18 @@
-# Bayesian Learning Control
+# Stable Learning Control
 
-[![Baysian Learning Control CI](https://github.com/rickstaa/bayesian-learning-control/actions/workflows/bayesian_learning_control.yml/badge.svg)](https://github.com/rickstaa/bayesian-learning-control/actions/workflows/bayesian_learning_control.yml)
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/rickstaa/bayesian-learning-control)](https://github.com/rickstaa/bayesian-learning-control/releases)
+[![Baysian Learning Control CI](https://github.com/rickstaa/stable-learning-control/actions/workflows/stable_learning_control.yml/badge.svg)](https://github.com/rickstaa/stable-learning-control/actions/workflows/stable_learning_control.yml)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/rickstaa/stable-learning-control)](https://github.com/rickstaa/stable-learning-control/releases)
 [![Python 3](https://img.shields.io/badge/Python->=3.8-brightgreen)](https://www.python.org/)
-[![codecov](https://codecov.io/gh/rickstaa/bayesian-learning-control/branch/main/graph/badge.svg?token=RFM3OELQ3L)](https://codecov.io/gh/rickstaa/bayesian-learning-control)
+[![codecov](https://codecov.io/gh/rickstaa/stable-learning-control/branch/main/graph/badge.svg?token=RFM3OELQ3L)](https://codecov.io/gh/rickstaa/stable-learning-control)
 [![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
 
 ## Package Overview
 
-Welcome to the Bayesian Learning Control (BLC) framework! The Bayesian Learning Control framework enables you to automatically create, train and deploy various safe (stable and robust) Reinforcement Learning (RL) and Imitation learning (IL) control algorithms directly from real-world data. This framework is made up of four main modules:
+Welcome to the Stable Learning Control (SLC) framework! The Stable Learning Control framework enables you to automatically create, train and deploy various safe (stable and robust) Reinforcement Learning (RL) and Imitation learning (IL) control algorithms directly from real-world data. This framework is made up of four main modules:
 
-*   [Modeling](./bayesian_learning_control/modeling): Module that uses state of the art System Identification and State Estimation techniques to create an [gymnasium environment](https://gymnasium.farama.org/) out of real data.
-*   [Control](./bayesian_learning_control/control): Module used to train several [Bayesian Learning Control](https://rickstaa.github.io/bayesian-learning-control/control/control.html) RL/IL agents on the built [gymnasium](https://gymnasium.farama.org/) environments.
-*   [Hardware](./bayesian_learning_control/hardware): Module that can be used to deploy the trained RL/IL agents onto the hardware of your choice.
+*   [Modeling](./stable_learning_control/modeling): Module that uses state of the art System Identification and State Estimation techniques to create an [gymnasium environment](https://gymnasium.farama.org/) out of real data.
+*   [Control](./stable_learning_control/control): Module used to train several [Stable Learning Control](https://rickstaa.github.io/stable-learning-control/control/control.html) RL/IL agents on the built [gymnasium](https://gymnasium.farama.org/) environments.
+*   [Hardware](./stable_learning_control/hardware): Module that can be used to deploy the trained RL/IL agents onto the hardware of your choice.
 
 This framework follows a code structure similar to the [Spinningup](https://spinningup.openai.com/en/latest/) educational package. By doing this, we hope to make it easier for new researchers to get started with our Algorithms. If you are new to RL, you are therefore highly encouraged first to check out the SpinningUp documentation and play with before diving into our codebase. Our implementation sometimes deviates from the [Spinningup](https://spinningup.openai.com/en/latest/) version to increase code maintainability, extensibility and readability.
 
@@ -21,7 +21,7 @@ This framework follows a code structure similar to the [Spinningup](https://spin
 Since the repository contains several git submodules to use all the features, it needs to be cloned using the `--recurse-submodules` argument:
 
 ```bash
-git clone --recurse-submodules https://github.com/rickstaa/bayesian-learning-control.git
+git clone --recurse-submodules https://github.com/rickstaa/stable-learning-control.git
 ```
 
 If you already cloned the repository and forgot the `--recurse-submodule` argument you can pull the submodules using the following git command:
@@ -32,7 +32,7 @@ git submodule update --init --recursive
 
 ## Installation and Usage
 
-Please see the [docs](https://rickstaa.github.io/bayesian-learning-control/) for installation and usage instructions.
+Please see the [docs](https://rickstaa.github.io/stable-learning-control/) for installation and usage instructions.
 
 ## Contributing
 

docs/Makefile

@@ -1,12 +1,12 @@
-# Makefile for Bayesian Learning Control Sphinx documentation
+# Makefile for Stable Learning Control Sphinx documentation
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = Bayesian Learning Control
+SPHINXPROJ    = Stable Learning Control
 SOURCEDIR     = source
 BUILDDIR      = build
-GH_PAGES_SOURCES = docs bayesian_learning_control examples
+GH_PAGES_SOURCES = docs stable_learning_control examples
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -56,4 +56,4 @@ gh-pages:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	git submodule update --init --recursive
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)