cleanup root dir

Author: alphaville

.gitignore

@@ -9,15 +9,21 @@ target/
 *.odp#
 *.egg-info
 *.pyc
-open-codegen/opengen/icasadi/extern/Makefile
+python/opengen/icasadi/extern/Makefile
 virt
 data
 my_optimizers
 .python_test_build
 dist/
 
 # Python tests create this folder:
-open-codegen/opengen/.python_test_build/
+python/.python_test_build/
+python/.python_test_build_ocp/
+python/.pytest_cache/
+python/build/
+python/dist/
+python/htmlcov/
+python/opengen.egg-info/
 
 # Haphazard files:
 __main.rs
@@ -26,31 +32,31 @@ design/open-interfaces.jpeg
 design/open-interfaces.odp
 design/open-interfaces.png
 main.rs
-open-codegen/run/
-open-codegen/venv*
+python/run/
+python/venv*
 
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-/Cargo.lock
+/rust/Cargo.lock
 open-clib/Cargo.lock
 
 # These are backup files generated by rustfmt
 *.rs.bk
 
 # Docusaurus website (autogenerated files)
-/website/i18n/
-/website/node_modules/
-/website/yarn.lock
-/website/build/
-/website/.docusaurus/
-!/website/pages/
-!/website/static/
-!/website/*.js
-!/website/blog/
-!/website/core/Footer.js
-!/website/README.md
-!/website/publish.sh
+/docs/website/i18n/
+/docs/website/node_modules/
+/docs/website/yarn.lock
+/docs/website/build/
+/docs/website/.docusaurus/
+!/docs/website/pages/
+!/docs/website/static/
+!/docs/website/*.js
+!/docs/website/blog/
+!/docs/website/core/Footer.js
+!/docs/website/README.md
+!/docs/website/publish.sh
 
 # icasadi external files
 /icasadi/extern/
@@ -59,7 +65,7 @@ open-clib/Cargo.lock
 /.vscode/
 
 # Main file
-/src/main.rs
+/rust/src/main.rs
 
 # Autogenerated files (builds)
 /autogenerated_*

Cargo.toml

@@ -66,7 +66,7 @@ OpEn allows application developers and researchers to focus on the challenges of
 ### Embedded applications
 OpEn can run on embedded devices; here we see it running on an intel Atom for the autonomous navigation of a lab-scale micro aerial vehicle - the controller runs at **20Hz** using only **15%** CPU!
 
-<img src="https://raw.githubusercontent.com/alphaville/optimization-engine/master/website/static/img/e8f236af8d38.gif" alt="Fast NMPC of MAV" width="55%"/>
+<img src="https://raw.githubusercontent.com/alphaville/optimization-engine/master/docs/website/static/img/e8f236af8d38.gif" alt="Fast NMPC of MAV" width="55%"/>
 
 
 ## Optimal Control
@@ -196,7 +196,7 @@ let status = optimizer.solve(&mut u)?;
 ```
 
 See the dedicated [Rust documentation](https://alphaville.github.io/optimization-engine/docs/openrust-basic) for a full introduction and more complete examples.
-See more Rust examples [here](examples).
+See more Rust examples [here](rust/examples).
 
 ## Check out next...
 

README.md

@@ -1,7 +1,19 @@
 #!/bin/bash
 set -euxo pipefail
 
+# To use locally, from the root directory and from a bash shell...
+#
+# 1. To run the core Python tests:
+#    ci/script.sh python-tests
+#
+# 2. To run the Python OCP tests:
+#    ci/script.sh ocp-tests
+#
+# 3. To run the Python ROS2 tests:
+#   ci/script.sh ros2-tests
+
 SKIP_RPI_TEST="${SKIP_RPI_TEST:-0}"
+DO_DOCKER="${DO_DOCKER:-0}"
 TASK="${1:-all-python-tests}"
 
 function run_clippy_test() {
@@ -25,7 +37,7 @@ function run_clippy_test() {
 }
 
 setup_python_test_env() {
-    cd open-codegen
+    cd python
     export PYTHONPATH=.
 
     python -m venv venv
@@ -106,36 +118,37 @@ test_docker() {
 }
 
 main() {
-    if [ $DO_DOCKER -eq 0 ]; then
-        case "$TASK" in
-            python-tests)
-                echo "Running Python tests and generated Clippy tests"
-                setup_python_test_env
-                run_python_core_tests
-                ;;
-            ros2-tests)
-                echo "Running ROS2 Python tests"
-                setup_python_test_env
-                run_python_ros2_tests
-                ;;
-            ocp-tests)
-                echo "Running OCP Python tests"
-                setup_python_test_env
-                run_python_ocp_tests
-                ;;
-            all-python-tests)
-                echo "Running Python tests, generated Clippy tests, and OCP tests"
-                all_python_tests
-                ;;
-            *)
-                echo "Unknown task: $TASK"
-                exit 1
-                ;;
-        esac
-    else
+    if [ "$DO_DOCKER" -ne 0 ]; then
         echo "Building Docker image"
         test_docker
+        return
     fi
+
+    case "$TASK" in
+        python-tests)
+            echo "Running Python tests and generated Clippy tests"
+            setup_python_test_env
+            run_python_core_tests
+            ;;
+        ros2-tests)
+            echo "Running ROS2 Python tests"
+            setup_python_test_env
+            run_python_ros2_tests
+            ;;
+        ocp-tests)
+            echo "Running OCP Python tests"
+            setup_python_test_env
+            run_python_ocp_tests
+            ;;
+        all-python-tests)
+            echo "Running Python tests, generated Clippy tests, and OCP tests"
+            all_python_tests
+            ;;
+        *)
+            echo "Unknown task: $TASK"
+            exit 1
+            ;;
+    esac
 }
 
 main

ci/script.sh

@@ -27,7 +27,7 @@ pip install sphinx
 pip install sphinx-rtd-theme
 
 # Install opengen
-pushd open-codegen
+pushd python
 pip install .
 popd # back to $GITHUB_WORKSPACE
 
@@ -48,11 +48,11 @@ git checkout $current_branch
 # Build the docs
 rm -rf sphinx
 mkdir -p sphinx
-pushd sphinx-dox
-sphinx-apidoc -o ./source/ ../open-codegen/opengen
+pushd docs/sphinx
+sphinx-apidoc -o ./source/ ../../python/opengen
 echo Last updated: $(date -u)  >> source/index.rst; sed '$d' source/index.rst; # update date at the end of file
 make html || :
-cp -r build/html/ ../sphinx
+cp -r build/html/ ../../sphinx
 git checkout source/index.rst # no need to commit this
 popd # back to $GITHUB_WORKSPACE