updating to Cinema:View

cinemascience · Mar 10, 2020 · 8da8878 · 8da8878
1 parent 2d74881
commit 8da8878
Show file tree

Hide file tree

Showing 31 changed files with 222 additions and 125 deletions.
diff --git a/docs/source/cinema_lib.rst b/docs/source/cinema_lib.rst
@@ -111,7 +111,7 @@ Image Color Conversion and Statistics
 
     $ cinema -d path_to_database/database_name.cdb  --image-grey 2
 
-Using :ref:`label_cinema_compare`, one can see that the original Viridis colormap has been converted to greyscale:
+Using :ref:`label_cinema_view`, one can see that the original Viridis colormap has been converted to greyscale:
 
 .. image:: images/mpas_static_Viridis_Grey.png
    :width: 97%
@@ -235,7 +235,7 @@ First use a *cinema_lib* function to convert the Viridis colormap to greyscale a
     $ cinema -d mpas_static.cdb --cv-grey 1
     $ cinema -d mpas_static.cdb --cv-fast-draw 2 --label FAST
 
-Once again, using :ref:`label_cinema_compare`, one can see the original Viridis colormap, its greyscale counterpart, and the FAST features added from the Computer Vision suite of functionality.  The FAST algorithm finds the eddies, land masses, and ocean currents:
+Once again, using :ref:`label_cinema_view`, one can see the original Viridis colormap, its greyscale counterpart, and the FAST features added from the Computer Vision suite of functionality.  The FAST algorithm finds the eddies, land masses, and ocean currents:
 
 .. image:: images/mpas_static_Viridis_Grey_Fast.png
    :width: 97%

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -158,3 +158,4 @@
 
 
 # -- Extension configuration -------------------------------------------------
+numfig = True
diff --git a/docs/source/databases.json → docs/source/example_explorer_databases.json b/docs/source/databases.json → docs/source/example_explorer_databases.json
diff --git a/docs/source/example_view_databases.json b/docs/source/example_view_databases.json
@@ -0,0 +1,39 @@
+[
+	{
+		"database_name-comment" : "The name of the dataset. It will appear in the dropdown.",
+		"database_name": "sphere test",
+
+		"databases-comment" : "JSON array containing list of datasets to compare",
+		"datasets":
+		[
+			{
+				"name-comment": "Each dataset must have a name that will appear at the top of the image",
+				"name": "sphere",
+
+				"location-comment" : "Location of the cinema database relative to cinema root or absolute paths",
+				"location": "data/sphere.cdb"
+			}
+		]
+	},
+
+	{
+		"database_name": "sedov test",
+		"datasets":
+		[
+			{
+				"name": "sedov 1",
+				"location": "data/sedov1.cdb"
+			},
+
+			{
+				"name": "sedov 2",
+				"location": "data/sedov2.cdb"
+			},
+
+			{
+				"name": "sedov 3",
+				"location": "data/sedov3.cdb"
+			}
+		]
+	}
+]
diff --git a/docs/source/images/CinemaCompareMPAS.png b/docs/source/images/CinemaCompareMPAS.png
diff --git a/docs/source/images/CinemaCompareSphere.png b/docs/source/images/CinemaCompareSphere.png
diff --git a/docs/source/images/CinemaCompareWarp.png b/docs/source/images/CinemaCompareWarp.png
diff --git a/docs/source/images/CinemaViewMPAS.png b/docs/source/images/CinemaViewMPAS.png
diff --git a/docs/source/images/CinemaViewSedov.png b/docs/source/images/CinemaViewSedov.png
diff --git a/docs/source/images/CinemaViewSphere.png b/docs/source/images/CinemaViewSphere.png
diff --git a/docs/source/images/CinemaViewWarp.png b/docs/source/images/CinemaViewWarp.png
diff --git a/docs/source/images/SelectDatabaseDropdown.png b/docs/source/images/SelectDatabaseDropdown.png
diff --git a/docs/source/images/SelectDatabaseLoadButton.png b/docs/source/images/SelectDatabaseLoadButton.png
diff --git a/docs/source/images/cs_DataDirectory.png b/docs/source/images/cs_DataDirectory.png
diff --git a/docs/source/images/cs_FileOpen.png b/docs/source/images/cs_FileOpen.png
diff --git a/docs/source/images/cs_MapParametersDialog.png b/docs/source/images/cs_MapParametersDialog.png
diff --git a/docs/source/images/cs_MapParametersDialogChoices.png b/docs/source/images/cs_MapParametersDialogChoices.png
diff --git a/docs/source/images/cs_openFile.png b/docs/source/images/cs_openFile.png
diff --git a/docs/source/images/explorerDropdownLoad.png b/docs/source/images/explorerDropdownLoad.png
diff --git a/docs/source/specD.rst b/docs/source/specD.rst
@@ -39,13 +39,14 @@ This example shows the header row and first few rows of the **data.csv** file fo
 The file structure for the images is thus arranged by time step then phi then theta and finally has the images for each of the five density isosurfaces:
 
 .. figure:: images/NyxFileSystemExplorer.png
+   :name: fileSystem
    :width: 97%
    :alt: Spec D file system
    :align: left
 
    An example of the file system organization for a large Cinema image database (from left to right): top .cdb directory, time steps, phi, theta and isosurfaces.
 
-The Cinema\:Compare and Cinema\:Explorer viewers are the basic viewers used with Cinema databases, :ref:`label_viewers`:.  The viewers are based on Spec D and provide the user with different approaches to viewing and exploring the data.  The user is free to develop other viewers and analysis approaches specific to their data.  The `CinemaScience Github`_ contains several repositories to support users in developing their own Cinema viewers.  An example using the Cinema\:Explorer viewer is shown in :ref:`label_cinema_explorer`.
+The Cinema:View and Cinema:Explorer viewers are the basic viewers used with Cinema databases, :ref:`label_viewers`:.  The viewers are based on Spec D and provide the user with different approaches to viewing and exploring the data.  The user is free to develop other viewers and analysis approaches specific to their data.  The `CinemaScience Github`_ contains several repositories to support users in developing their own Cinema viewers.  An example using the Cinema\:Explorer viewer is shown in :ref:`label_cinema_explorer`.
 
 .. _Dietrich (Spec D) : https://github.com/cinemascience/cinema/blob/master/specs/dietrich/01/cinema_specD_v012.pdf
 .. _CinemaScience Github : https://github.com/cinemascience

diff --git a/docs/source/tutorial_other.rst b/docs/source/tutorial_other.rst
@@ -23,6 +23,28 @@ Simply run the **upgrade_cinema_database** script giving the path to your Spec A
 
     $ upgrade_cinema_database /path_to_database/database_name.cdb
 
+
+.. _label_browser_security:
+
+A Note on Browser Security
+--------------------------
+
+To use the browser-based viewers, you **MUST** allow local file access. Do this in the following way, but be sure to reset these options when you are done as this allows loading of a file from any folder.
+
+- **Firefox (preferred)**
+    - In the brower search bar, enter ``about:config``
+    - Set ``privacy.file_unique_origin`` to **false**
+    - Set ``security.fileuri.strict_origin_policy`` to **false**
+
+- **Safari**
+    - Safari->Preferences->Advanced->Show Develop menu in menu bar
+    - Safari->Develop->Disable Local File Restrictions (on)
+
+- **Chrome**
+    - open **chrome** with the option ``--disable-web-security``
+    - Mac example:
+        ``open -na "Google Chrome" cinema_view.html --args --user-data-dir="<path/to/repo>" --disable-web-security``
+
 The `CinemaScience GitHub`_ page and the `CinemaScience website`_ are useful sources for more information and ideas.
 
 .. _CinemaScience GitHub : https://github.com/cinemascience