more github cleanup

Author: lwanger

README.md

@@ -9,19 +9,22 @@ This is an implementation of a Python ray tracer base on Pete Shirley's [Ray Tra
     - Primitives: Sphere, Disc Triangle, Plane, STL Files (triangle meshes)
     - Texture mapping: SolidColor, CheckerBoard, ImageTexture
     - Noise textures using [Perlin noise](https://en.wikipedia.org/wiki/Perlin_noise) for solid textures.
+    - Colormaps for noise textures. colorcet package included in requirements to provide perceptually linear
+        colormaps.
     - Lighting: Point lights, Area lights (can use any Geometry with a point_on method -- triangle, disc, 
         sphere, etc.) 
     - Shadow rays for shadowing. Area lights drive their own shadow ray sampling for soft shadows.
     - BVH (bounding volume hieraerchy)
+    - Multi-threaded GUI to provide image preview and ability to cancel an in-progress rendering.
     - models: teapots, bunnies, etc.
 
 ## Install
 
 1. Install Python 3.6+
-2. For the gui version, make sure tkinter is available (type: *python -c "import tkinter"* to test). If this fails
+2. For the gui version, make sure tkinter is available (type: **python -c "import tkinter"** to test). If this fails
 you'll need to install tkinter for your platform
 3. Download/clone this git repository
-4. install the required packages: *pip install -r requirements.txt*
+4. install the required packages: **pip install -r requirements.txt**
 
 note 1: I have not tested the install on other systems. Let me know if there's an issue.
 
@@ -33,18 +36,18 @@ The easiest with to run the program is to use the GUI:
 
 ![GUI](images/gui.png)
 
-    type: *python rt_gui.py*
+    type: **python rt_gui.py**
 
-Then Click on the *start* button to start the rendering. The image will be saved in the current working directory
-as *rt.png* (unless changed by the IMAGE_FILENAME environment variable.)
+Then Click on the **start** button to start the rendering. The image will be saved in the current working directory
+as **rt.png** (unless changed by the IMAGE_FILENAME environment variable.)
 
 note: There are a lot of features that could be added to the GUI. Top of the list is to set the scene file from a
 command line option or menu item. For now it is hard-coded in the code. To change the scene, set the 
 CREATOR_FUNC variable:
 
     CREATOR_FUNC = create_canonical_1
 
-There are several sample scene files in *create_scene_funcs.py*.    
+There are several sample scene files in **create_scene_funcs.py**.    
 
 The program can be run from the command line with:
 

geometry_classes.py

@@ -142,7 +142,7 @@ def get_color(val, colormap):
 
 class Vec3():
     def __init__(self, x,y,z):
-        self.x = x
+        self.x = xcl
         self.y = y
         self.z = z
 

scene.py

@@ -19,16 +19,11 @@ def __init__(self, geometry: GeometryList, lights=None, ambient=None, background
         """
         Class the represent a scene. Includes the geometry and lighting.
 
+        :param geometry: a list of primitives (Geometry) objects for the scene
+        :param lights: a list of lights (LightBase) objects for the scene
         ambient: ambient lighting
         background: background texture
-        TODO:
-            add lighting
-            add start and end time
-            add rendering?
-            add camera?
         """
-        # self.geometry = geometry  # not needed if you have bvh...
-        # self.ambient = ambient_light  # Vec3
         self.bvh = BVHNode(geometry)
 
         if lights is None: