Updated docs, readmes, docstrings, comments etc

AutodeskRoboticsLab · Sep 19, 2018 · e9cd19e · e9cd19e
1 parent 5b935cb
commit e9cd19e
Show file tree

Hide file tree

Showing 21 changed files with 561 additions and 152 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ Download the latest [release](https://github.com/AutodeskRoboticsLab/Mimic/relea
 macOS   ~/Library/Preferences/Autodesk/maya/modules
 Windows ~/Documents/maya/modules
 ```
-If you're running Windows or Linux, you must install NumPy manually for Mimic's Analysis module to run properly. Download the correct version from the  [releases](https://github.com/AutodeskRoboticsLab/Mimic/releases) page and place the unzipped `numpy` folder in the `scripts/extern` directory. _note: macOS come with NumPy pre-installed, so if you're using a Mac, you do not have to install NumPy manually_
+If you're running Windows, you must install NumPy manually for Mimic's Analysis module to run properly. Download numpy for Windows from the [releases](https://github.com/AutodeskRoboticsLab/Mimic/releases) page and place the unzipped `numpy` root folder in the `scripts/extern` directory. _note: macOS come with NumPy pre-installed, so if you're using a Mac, you do not have to install NumPy manually_
 
 When you're done, open Maya, click on the Mimic shelf tab, and click on the Mimic icon; that's it!
 

diff --git a/mimic.mod b/mimic.mod
@@ -1,3 +1,3 @@
-+ mimic 1.1 ../modules/mimic
++ mimic 1.2 ../modules/mimic
 MAYA_SHELF_PATH +:= shelves
 PYTHONPATH +:= scripts/extern
diff --git a/mimic/docs/AUTHORS.md b/mimic/docs/AUTHORS.md
@@ -1,4 +1,4 @@
-# Mimic
+# Mimic Authors
 
 *Mimic was born at the Autodesk Robotics Lab, 2018.* It is now developed
 and contributed to by a community of animators, designers, engineers, architects,

diff --git a/mimic/docs/CONTRIBUTING.md b/mimic/docs/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Mimic
+# Mimic | Contributing
 
 ### Contributing
 

diff --git a/mimic/docs/_features.md b/mimic/docs/_features.md
@@ -1,4 +1,4 @@
-# Mimic
+# Mimic Features
 
 ### Feature index
 
@@ -93,25 +93,27 @@ At time of writing, the following features are available using the Mimic UI:
                 |-- Configure A4
                 |-- Configure A5
                 |-- Configure A6
-                |-- Configure E1
-                |-- Configure E2
-                |-- Configure E3
-                |-- Configure E4
-                |-- Configure E5
-                |-- Configure E6
             |-- Velocity
                 |-- Configure A1
                 |-- Configure A2
                 |-- Configure A3
                 |-- Configure A4
                 |-- Configure A5
                 |-- Configure A6
-                |-- Configure E1
-                |-- Configure E2
-                |-- Configure E3
-                |-- Configure E4
-                |-- Configure E5
-                |-- Configure E6
+            |-- Accel
+                |-- Configure A1
+                |-- Configure A2
+                |-- Configure A3
+                |-- Configure A4
+                |-- Configure A5
+                |-- Configure A6
+            |-- Jerk
+                |-- Configure A1
+                |-- Configure A2
+                |-- Configure A3
+                |-- Configure A4
+                |-- Configure A5
+                |-- Configure A6                
             |-- Get Axis Limits
             |-- Set Axis Limits
             |-- Clear

diff --git a/mimic/docs/_packages.md b/mimic/docs/_packages.md
@@ -1,5 +1,4 @@
-
-# Mimic
+# Mimic Packages
 
 ### Package index
 
@@ -33,7 +32,7 @@ in Mimic and, from them, producing usable robot code.
 Documentation may be found in:
 [postproc.md](mimic/scripts/postproc/postproc.md).
 
-Subpackages contained in postproc are as follows:
+Subpackages contained in `postproc` are as follows:
 
 
 ```
@@ -72,6 +71,17 @@ External libraries leveraged by Mimic
 Documentation may be found in:
 [extern.md](mimic/scripts/extern/extern.md).
 
+Subpackages contained in `extern` are as follows:
+
+
+```
+|-- extern
+    |-- Qt.py
+    |-- pyqtgraph
+        |-- ...
+    |-- numpy **
+        |-- ...
+```
 
 ### robotmath
 

diff --git a/mimic/docs/_repository.md b/mimic/docs/_repository.md
@@ -1,4 +1,4 @@
-# Mimic
+# Mimic Repository
 
 ### Repository index
 
@@ -35,6 +35,8 @@ At time of writing, the following contents are located in the Mimic repository:
         |-- mimic_logo_square_tesselated_dark_shelfIcon.png
         |-- mimic_logo_square_tesselated_light_shelfIcon.png
         |-- setDirectory_icon.png
+        |-- toggle_button_on.png
+        |-- toggle_button_off.png
     |-- logos
         |-- ...
     |-- plug-ins
@@ -152,6 +154,10 @@ At time of writing, the following contents are located in the Mimic repository:
             |-- __init__.py
             |-- inverse_kinematics.py
             |-- transforms.py
+        |-- extern
+            |-- Qt.py
+            |-- pyqtgraph
+            |-- numpy (if necessary)
     |-- shelves
         |-- shelf_Mimic.mel
         |-- shelves.md

diff --git a/mimic/docs/guide.md b/mimic/docs/guide.md
@@ -1,6 +1,4 @@
-# Mimic
-
-### Developer guide
+# Mimic Developer Guide
 
 This document is meant to provide an overview of the Mimic codebase so that
 its easier for programmers to start modifying or contributing to it. While it

diff --git a/mimic/docs/troubleshooting.md b/mimic/docs/troubleshooting.md
@@ -1,6 +1,4 @@
-# Mimic
-
-### Troubleshooting
+# Mimic | Troubleshooting
 
 In case of problems, see the below. If all else fails, copy the error you
 receive and send a detailed description to us at [mimic@autodesk.com](mailto:mimic@autodesk.com).
@@ -59,7 +57,7 @@ receive and send a detailed description to us at [mimic@autodesk.com](mailto:mim
 
 ### General tips
 
-- Try closing and reopening Mimic and/or Autodesk Maya.
+- Try closing and reopening Mimic and/or Autodesk Maya after new install.
 
 - If you get an error, launch the Maya Script Editor to track it down. Follow the
   instructions provided [here](https://knowledge.autodesk.com/support/maya/learn-explore/caas/CloudHelp/cloudhelp/2016/ENU/Maya/files/GUID-7C861047-C7E0-4780-ACB5-752CD22AB02E-htm.html).
@@ -69,5 +67,10 @@ receive and send a detailed description to us at [mimic@autodesk.com](mailto:mim
   Hover your cursor over an element to view these details. *At time of writing,
   this kind of documentation is not yet implemented for all UI elements.*
 
+- If you're using Maya 2016, and it continually crashes when you  analyze or 
+  save a program , try  changing Maya's evaluation mode from *Parallel* to *DG* by going to: 
+  `Windows > Settings/Preferencs > Preferences` > 
+  `Settings > Animation` > 
+  `Evaluation > Evaluation Mode > DG`
 
 #
diff --git a/mimic/docs/vocabulary.md b/mimic/docs/vocabulary.md
@@ -1,4 +1,4 @@
-# Mimic
+# Mimic Vocabulary
 
 ### Vocabulary
 

diff --git a/mimic/plug-ins/plug-ins.md b/mimic/plug-ins/plug-ins.md
@@ -1,6 +1,4 @@
-# Mimic
-
-### Plug-ins
+# Mimic Plug-ins
 
 Scipts in this folder are Maya
 [Depend Graph Plug-ins](https://help.autodesk.com/view/MAYAUL/2017/ENU/?guid=__files_GUID_A9070270_9B5D_4511_8012_BC948149884D_htm)

diff --git a/mimic/scripts/analysis/analysis.md b/mimic/scripts/analysis/analysis.md
@@ -1,5 +1,42 @@
-# Mimic
+# Mimic Analysis
 
-### Overview
+This is the analysis module of Mimic; it generally takes a program as animated in Maya, calculates the first, second, and third derivatives of the program (i.e. Velocity, Acceleration, and Jerk), and prepares a graphical representation of that data, along with the program itself.
+
+
+### Organization
+
+```
+|-- scripts
+    |-- analysis
+        |-- analysis.py
+        |-- analysis_utils.py
+        |-- analysis_ui.py
+        |-- analysis_ui_utils.py *
+        |-- analysis_ui_config.py
+```
+
+- `analysis.py`
+  contains only a single, high-level function which takes a program generated
+  by Mimic, and produces a graphical UI to interract with the corresponding data.
+
+- `analysis_utils.py`
+  contains the majority of the utility functions used for manipulating program
+  data, generating derivatives, etc.
+
+- `analysis_ui.py`
+  configures and creates the Mimic Anaylsis user interface.
+
+- `analysis_ui_utils.py`
+  contains custom UI classes used to create the Mimic analysis UI
+
+- `analysis__ui_config.py`
+  contains a few global variables used to configure default options for the 
+  analysis UI when launched.
+
+
+### Dependencies
+
+The Analysis module is dependent on both PyQtGraph and NumPy.
+See [extern.md](mimic/scripts/extern.md) for more details about these modules
 
 #
diff --git a/mimic/scripts/analysis/analysis.py b/mimic/scripts/analysis/analysis.py
@@ -18,6 +18,15 @@
 
 def run(robot_name, command_dicts, limit_data):
     """
+    Main function that runs Mimic Analysis graphing module
+    Takes input params and generates/formats the program's derivatives,
+    generates graphing UI, and adds data to the UI for the user to interract
+    with
+    :param robot_name: str, name of robot whose program is to be analyzed
+    :param command_dicts: list formatted by mimic_program containing dicts of
+        program info at each program timestep
+    :param limit_data: dict containing the position/velocity/acce;/jerk limits
+        for given robot
     """
     window_name='mimic_analysis_window'
 
@@ -42,6 +51,5 @@ def run(robot_name, command_dicts, limit_data):
     # TO-DO: add external axis limit data
     mimic_analysis_window.analysis_plot.add_limit_data(limit_data)
 
-    # TO-DO: Set toggles based on user config file
     mimic_analysis_window.initialize_toggle_states()