Merge pull request #164 from maxspahn/develop

v.0.5.1

.github/workflows/docs_pages.yaml

@@ -43,7 +43,7 @@ jobs:
       #----------------------------------------------
       - name: Install dependencies
         if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
+        run: poetry install --with dev --no-interaction --no-root
       #----------------------------------------------
       # install your root project, if required
       #----------------------------------------------

.github/workflows/unitTest.yml

@@ -48,7 +48,7 @@ jobs:
       #----------------------------------------------
       - name: Install dependencies
         if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root
+        run: poetry install --no-interaction --no-root --with dev
       #----------------------------------------------
       # install your root project, if required
       #----------------------------------------------

CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.5.1
+
+
+### Bug Fixes
+
+- Changes to adding subgoals instead of composition.
+
+### Ft[installation]
+
+- Updates poetry structure.
+- Updates actions and docs for poetry config update.
+
+### Ft[sensors]
+
+- Gives FullSensor access to all attributes of environment.
+- Uses pybullet state estimator.
+
+### Ft[video]
+
+- Adds function to start and stop video recording.
+- Adds function wrapper to adjust camera configuration.
+- Adds function wrapper to get camera configuration.
+
+<!-- generated by git-cliff -->

README.md

@@ -122,7 +122,7 @@ pip3 install '.[options]'
 Using poetry
 
 ``` {.sourceCode .bash}
-poetry install -E <options>
+poetry install --with <options>
 ```
 
 Options are `keyboard`.

cliff.toml

@@ -0,0 +1,66 @@
+# configuration file for git-cliff
+# see https://github.com/orhun/git-cliff#configuration-file
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+    # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactor"},
+    { message = "^style", group = "Styling"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { body = ".*security", group = "Security"},
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "v[0-9]*"
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"
+# regex for ignoring tags
+ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42

docs/source/getting_started.rst

@@ -71,10 +71,7 @@ Optional: Installation with poetry
 ------------------------------------
 
 If you want to use `poetry <https://python-poetry.org/docs/>`_, you have to install it
-first. See their webpage for instructions `docs <https://python-poetry.org/docs/>`_. Once
-poetry is installed, you can install the virtual environment with the following commands.
-Note that during the first installation ``poetry update`` takes up to 300 secs.
-
+first. See their webpage for instructions `docs <https://python-poetry.org/docs/>`_.
 .. code:: bash
 
     poetry install
@@ -102,7 +99,7 @@ Using poetry
 
 .. code:: bash
 
-    poetry install -E <options>
+    poetry install --with <options>
 
 Options are ``keyboard``.
 

docs/source/introduction.rst

@@ -40,9 +40,9 @@ Using poetry
 
 .. code:: bash
 
-    poetry install -E <options>
+    poetry install --with <options>
 
-Options are ``keyboard`` and ``scenes``.
+Options are ``keyboard``.
 
 Switching
 =========

examples/point_robot.py

@@ -28,6 +28,7 @@ def run_point_robot(n_steps=1000, render=False, goal=True, obstacles=True):
     if goal:
         env.add_goal(splineGoal)
     history = []
+    env.reconfigure_camera(2.0, 0.0, -90.01, (0, 0, 0))
     for _ in range(n_steps):
         ob, _, _, _ = env.step(action)
         history.append(ob)