Add Sina as Axom component

src/axom/sina/CMakeLists.txt

@@ -14,15 +14,6 @@
 axom_component_requires(NAME       Sina
                         TPLS       Conduit )
 
-#------------------------------------------------------------------------------
-# Set sina version
-#------------------------------------------------------------------------------
-set(SINA_VERSION_MAJOR 1)
-set(SINA_VERSION_MINOR 14)
-set(SINA_VERSION_PATCH 0)
-axom_configure_file ( config.hpp.in
-                      ${PROJECT_BINARY_DIR}/include/axom/sina/config.hpp )
-
 #------------------------------------------------------------------------------
 # Specify the sina headers/sources
 #------------------------------------------------------------------------------
@@ -62,7 +53,7 @@ blt_list_append( TO sina_sources ELEMENTS core/AdiakWriter.cpp IF AXOM_USE_ADIAK
 if (ENABLE_FORTRAN)
   blt_list_append( TO sina_headers ELEMENTS interface/sina_fortran_interface.h)
   blt_list_append( TO sina_sources
-                   ELEMENTS interface/sina_fortran_interface.cpp interface/sina_fortran_interface.f90)
+                   ELEMENTS interface/sina_fortran_interface.cpp interface/sina_fortran_interface.f)
 endif()
 
 #------------------------------------------------------------------------------

src/axom/sina/core/Document.hpp

@@ -24,6 +24,9 @@
 #include "axom/sina/core/Record.hpp"
 #include "axom/sina/core/Relationship.hpp"
 
+#define SINA_FILE_FORMAT_VERSION_MAJOR 1
+#define SINA_FILE_FORMAT_VERSION_MINOR 0
+
 namespace axom
 {
 namespace sina
@@ -73,6 +76,11 @@ namespace sina
  *   axom::sina::saveDocument(myDocument, "path/to/outfile.json")
  * \endcode
  *
+ * Check the Sina file format version with:
+ * \code
+ *   axom::sina::getSinaFileFormatVersion();
+ * \endcode
+ *
  */
 class Document
 {
@@ -199,6 +207,16 @@ class Document
  */
 void saveDocument(Document const &document, std::string const &fileName);
 
+/**
+ * \brief Get the current file format version.
+ *
+ * \return A string representing the file format version.
+ */
+inline std::string getSinaFileFormatVersion() {
+  return std::to_string(SINA_FILE_FORMAT_VERSION_MAJOR) + "." +
+         std::to_string(SINA_FILE_FORMAT_VERSION_MINOR);
+}
+
 /**
  * \brief Load a document from the given path. Only records which this library
  *        knows about will be able to be loaded.

src/axom/sina/examples/CMakeLists.txt

@@ -27,10 +27,10 @@ set(sina_example_sources
     sina_view_datum_values.cpp
 )
 
-set(sina_example_depends sina conduit::conduit)
+set(sina_example_depends sina conduit slic)
 
 if (ENABLE_FORTRAN)
-    blt_list_append( TO sina_example_sources ELEMENTS sina_fortran.f90)
+    blt_list_append( TO sina_example_sources ELEMENTS sina_fortran.f)
 endif()
 
 #------------------------------------------------------------------------------

src/axom/sina/examples/sina_check_datum_type.cpp

@@ -4,28 +4,51 @@
 // SPDX-License-Identifier: (BSD-3-Clause)
 
 #include "axom/sina.hpp"
+#include "axom/slic.hpp"
+
+using ValueTypeUnderlying =
+  typename std::underlying_type<axom::sina::ValueType>::type;
+
+void getType(axom::sina::Datum datum, std::string datumName, std::string errMsg)
+{
+  auto datumType = static_cast<ValueTypeUnderlying>(datum.getType());
+  SLIC_ASSERT_MSG(
+    static_cast<bool>(
+      std::is_same<decltype(datumType), ValueTypeUnderlying>::value),
+    errMsg);
+  std::cout << datumName << " type: " << datumType << std::endl;
+}
 
 int main(void)
 {
+  // Initialize slic
+  axom::slic::initialize();
+
   // Define 3 different datums
   axom::sina::Datum myDatum {12.34};
   std::string value = "foobar";
   axom::sina::Datum myOtherDatum {value};
   std::vector<double> scalars = {1, 2, 20.0};
   axom::sina::Datum myArrayDatum {scalars};
 
-  // Prints 0, corresponding to string
-  std::cout << static_cast<std::underlying_type<axom::sina::ValueType>::type>(
-                 myDatum.getType())
-            << std::endl;
+  // Prints 1, corresponding to Scalar
+  getType(myDatum,
+          "myDatum",
+          "myDatumType did not match the expected type 'Scalar' (numerically "
+          "represented as 1).");
+
+  // Prints 0, corresponding to String
+  getType(myOtherDatum,
+          "myOtherDatum",
+          "myDatumType did not match the expected type 'String' (numerically "
+          "represented as 0).");
 
-  // Prints 1, corresponding to scalar
-  std::cout << static_cast<std::underlying_type<axom::sina::ValueType>::type>(
-                 myOtherDatum.getType())
-            << std::endl;
+  // Prints 3, corresponding to ScalarArray
+  getType(myArrayDatum,
+          "myArrayDatum",
+          "myArrayDatum did not match the expected type 'ScalarArray' "
+          "(numerically represented as 3).");
 
-  // Prints 3, corresponding to scalar array
-  std::cout << static_cast<std::underlying_type<axom::sina::ValueType>::type>(
-                 myArrayDatum.getType())
-            << std::endl;
+  // Finalize slic
+  axom::slic::finalize();
 }

src/axom/sina/examples/sina_create_datum.cpp

@@ -4,9 +4,13 @@
 // SPDX-License-Identifier: (BSD-3-Clause)
 
 #include "axom/sina.hpp"
+#include "axom/slic.hpp"
 
 int main(void)
 {
+  // Initialize slic
+  axom::slic::initialize();
+
   // Create the record
   axom::sina::ID myID {"my_record", axom::sina::IDType::Local};
   std::unique_ptr<axom::sina::Record> myRecord {
@@ -18,5 +22,28 @@ int main(void)
 
   // Add the datum to the record
   myRecord->add("my_scalar", std::move(myDatum));
-  std::cout << myRecord->toNode().to_json() << std::endl;
+
+  // Compare the actual output to the expected JSON output, then print it to console
+  std::string actualJsonString = myRecord->toNode().to_json();
+  std::string expectedJsonString = R"(
+{
+  "data": 
+  {
+    "my_scalar": 
+    {
+      "value": 
+      [
+        "input"
+      ]
+    }
+  },
+  "type": "my_type",
+  "local_id": "my_record"
+})";
+  SLIC_ASSERT_MSG(actualJsonString.compare(expectedJsonString) == 0,
+                  "JSON output does not match expected structure.");
+  std::cout << actualJsonString << std::endl;
+
+  // Finalize slic
+  axom::slic::finalize();
 }

src/axom/sina/examples/sina_curve_set.cpp

@@ -9,15 +9,13 @@
 #include <cmath>
 #include <vector>
 
-using namespace std;
-
 struct BounceData
 {
-  vector<double> time;
-  vector<double> xPosition;
-  vector<double> yPosition;
-  vector<double> xVelocity;
-  vector<double> yVelocity;
+  std::vector<double> time;
+  std::vector<double> xPosition;
+  std::vector<double> yPosition;
+  std::vector<double> xVelocity;
+  std::vector<double> yVelocity;
 };
 
 BounceData generateBounceData(double initialY,
@@ -67,7 +65,9 @@ BounceData generateBounceData(double initialY,
   return data;
 }
 
-void addCurveSet(axom::sina::Record &record, BounceData bounceData, string curveName)
+void addCurveSet(axom::sina::Record &record,
+                 BounceData bounceData,
+                 std::string curveName)
 {
   // Create the curve set object
   axom::sina::CurveSet bounceCurveSet {curveName};
@@ -112,7 +112,7 @@ int main()
   axom::sina::Document doc;
 
   axom::sina::ID id {"ball_bounce_run", axom::sina::IDType::Global};
-  unique_ptr<axom::sina::Record> study {
+  std::unique_ptr<axom::sina::Record> study {
     new axom::sina::Record {id, "ball bounce study"}};
 
   addCurveSet(*study, bounceData, "ball_bounce");

src/axom/sina/examples/sina_file_object_creation.cpp

@@ -4,9 +4,13 @@
 // SPDX-License-Identifier: (BSD-3-Clause)
 
 #include "axom/sina.hpp"
+#include "axom/slic.hpp"
 
 int main(void)
 {
+  // Initialize slic
+  axom::slic::initialize();
+
   // Create 2 different files
   axom::sina::File myFile {"/path/to/file.png"};
   myFile.setMimeType("image/png");
@@ -22,5 +26,33 @@ int main(void)
   myRecord->add(myFile);
   myRecord->add(myOtherFile);
 
-  std::cout << myRecord->toNode().to_json() << std::endl;
+  // Compare the actual output to the expected JSON output, then print it to console
+  std::string actualJsonString = myRecord->toNode().to_json();
+  std::string expectedJsonString = R"(
+{
+  "type": "my_type",
+  "local_id": "my_record",
+  "files": 
+  {
+    "/path/to/other/file.txt": 
+    {
+      "tags": 
+      [
+        "these",
+        "are",
+        "tags"
+      ]
+    },
+    "/path/to/file.png": 
+    {
+      "mimetype": "image/png"
+    }
+  }
+})";
+  SLIC_ASSERT_MSG(actualJsonString.compare(expectedJsonString) == 0,
+                  "JSON output does not match expected structure.");
+  std::cout << actualJsonString << std::endl;
+
+  // Finalize slic
+  axom::slic::finalize();
 }

src/axom/sina/examples/sina_file_object_removal.cpp

@@ -4,9 +4,13 @@
 // SPDX-License-Identifier: (BSD-3-Clause)
 
 #include "axom/sina.hpp"
+#include "axom/slic.hpp"
 
 int main(void)
 {
+  // Initialize slic
+  axom::slic::initialize();
+
   // Create 2 different files
   axom::sina::File myFile {"/path/to/file.png"};
   myFile.setMimeType("image/png");
@@ -25,5 +29,29 @@ int main(void)
   // Remove a file from the record
   myRecord->remove(myFile);
 
-  std::cout << myRecord->toNode().to_json() << std::endl;
+  // Compare the actual output to the expected JSON output, then print it to console
+  std::string actualJsonString = myRecord->toNode().to_json();
+  std::string expectedJsonString = R"(
+{
+  "type": "my_type",
+  "local_id": "my_record",
+  "files": 
+  {
+    "/path/to/other/file.txt": 
+    {
+      "tags": 
+      [
+        "these",
+        "are",
+        "tags"
+      ]
+    }
+  }
+})";
+  SLIC_ASSERT_MSG(actualJsonString.compare(expectedJsonString) == 0,
+                  "JSON output does not match expected structure.");
+  std::cout << actualJsonString << std::endl;
+
+  // Finalize slic
+  axom::slic::finalize();
 }

src/axom/sina/examples/sina_query_records_relationships.cpp

@@ -4,9 +4,13 @@
 // SPDX-License-Identifier: (BSD-3-Clause)
 
 #include "axom/sina.hpp"
+#include "axom/slic.hpp"
 
 int main(void)
 {
+  // Initialize slic
+  axom::slic::initialize();
+
   // Create a new document
   axom::sina::Document document;
 
@@ -35,6 +39,12 @@ int main(void)
   auto &records = document.getRecords();
   auto &relationships = document.getRelationships();
 
+  SLIC_ASSERT_MSG(records.size() == 2, "Unexpected number of records found.");
   std::cout << "Number of Records: " << records.size() << std::endl;
+  SLIC_ASSERT_MSG(relationships.size() == 1,
+                  "Unexpected number of relationships found.");
   std::cout << "Number of Relationships: " << relationships.size() << std::endl;
+
+  // Finalize slic
+  axom::slic::finalize();
 }