Merge pull request #7 from IntelligentCampus/develop

Documentation Rewrite and SkySpark 3.1 Changes: Merging for v0.9.4 release

LICENSE.md

@@ -1,4 +1,11 @@
-Copyright (C) 2017 National Renewable Energy Laboratory
-All Rights Reserved
+nrelCsvExt Copyright (c) 2022 Alliance for Sustainable Energy, LLC. All rights reserved.
 
-Approved for NREL internal use only at this time.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,10 +1,18 @@
-csvExt: CSV Data Import Functions
-=================================
+nrelCsvExt: Import and Export Functions for CSV Data
+====================================================
 
-**csvExt** is a [SkySpark] extension that provides a set of functions for importing data from comma
-separated value (CSV) files.
+**nrelCsvExt** is a [SkySpark] extension that provides utility functions for the
+import and export of CSV data implement in the [Axon] programming language. This
+package is developed and provided free of charge by the
+[National Renewable Energy Laboratory].
 
 [SkySpark]: http://skyfoundry.com/skyspark/ "SkySpark"
+[Axon]: https://skyfoundry.com/doc/docHaxall/AxonLang "Axon Language"
+[National Renewable Energy Laboratory]: https://www.nrel.gov
+
+**nrelCsvExt** requires SkySpark 3.1 or later and [nrelUtilityExt] 1.1 or later.
+
+[nrelUtilityExt]: https://github.com/NREL/nrelUtilityExt/ "NREL Utility Extension"
 
 Build
 -----
@@ -13,50 +21,55 @@ Build instructions:
 
 1. Create a local clone of this repository on a computer with a working copy of SkySpark.
 2. From the command line, change directory to the SkySpark root directory.
-3. Execute `bin/fan /path/to/csvExt/build.fan`.
-   * On Linux, you may need to `chmod +x bin/fan` first.
-   * Output pod will be `lib/fan/csvExt.pod` (relative to SkySpark root).
+3. Execute `bin/fan /path/to/nrelCsvExt/build.fan`.
+   - On Linux, you may need to `chmod +x bin/fan` first.
+   - Output pod will be `lib/fan/nrelCsvExt.pod` (relative to SkySpark root).
 4. Execute `bin/fan docgen` to regenerate documentation.
 
 Build instructions are the same for Windows except paths use backslashes `\` and `fan` becomes
 `fan.bat`.
 
-Note that all dependencies need to be in `lib/fan/` (relative to SkySpark root); the build script
-will not find pods located in `var/lib/fan/`.
+Note that all dependencies need to be in `lib/fan` (relative to SkySpark root); the build script
+will not find pods located in `var/lib/fan`.
 
 Installation
 ------------
 
-Select a set of installation instructions below that corresponds to how you obtained the
-**csvExt** extension. Following installation, you must enable the *CSV* extension in the *Exts* tab
-of the SkySpark *Settings* app within each project that needs access to the functions.
+Select a set of installation instructions below that corresponds to how you
+obtained the **nrelCsvExt** extension. Following installation, you must enable
+the *nrelCsv* extension in the *Exts* tab of the SkySpark *Settings* app within
+each project that needs access to the functions.
 
 ### From Source ###
 
-If you built from source, all that is needed to install the extension is to start (or restart)
-SkySpark.
+If you built from source, all that is needed to install the extension is to
+start (or restart) SkySpark.
 
 ### From GitHub ###
 
-1. Download a `csvExt.pod` release from GitHub.
-2. Copy `csvExt.pod` into the `lib/fan/` directory of your SkySpark installation.
-3. Set ownership permissions correctly on the pod to match the other pods in your SkySpark
-   installation (Linux/Mac).
+*This package is not yet available on Github.com; currently on NREL internal Github only*
+
+1. Download a `nrelCsvExt.pod` release from GitHub.
+2. Copy `nrelCsvExt.pod` into the `lib/fan/` directory of your SkySpark
+   installation.
+3. Set ownership permissions correctly on the pod to match the other pods in
+   your SkySpark installation (Linux/Mac).
 4. From the command line, change directory to the SkySpark root directory.
 5. Execute `bin/fan docgen` to regenerate documentation.
-   * Optional; the functions will work without this step but the *Help* app won't show any
-     function documentation.
-   * On Linux, you may need to `chmod +x bin/fan` first.
+   - Optional; the functions will work without this step but the *Doc* app
+     won't show any function documentation.
+   - On Linux, you may need to `chmod +x bin/fan` first.
 6. Start (or restart) SkySpark.
 
 Help
 ----
 
-Function help is available in the SkySpark *Help* app under *csv* or within the help interface
-in the *Func* app.
+Function documentation is available in the SkySpark *Doc* app under *nrelCsv* or
+within the *Docs* interface in the *Code* app.
 
 License
 -------
 
-At present, these functions are for NREL internal use only. See `LICENSE.md` for details.
+This software is licensed for use under the terms of the Berkeley Software
+Distribution 3-clause (BSD-3) license; see `LICENSE.md`.
 

build.fan

@@ -1,37 +1,41 @@
 #! /usr/bin/env fan
 
-// Copyright (C) 2017, National Renewable Energy Laboratory
+// Copyright (C) 2022, Alliance for Sustainable Energy, LLC
 // All Rights Reserved
 
 using build
 
 **
-** Build: csvExt
+** Build: nrelCsvExt
 **
+
 class Build : BuildPod
 {
   new make()
   {
-    podName = "csvExt"
-    summary = "CSV Data Import Functions"
-    version = Version("0.9.3")
+    podName = "nrelCsvExt"
+    summary = "Import and export functions for CSV data"
+    version = Version("0.9.4")
     meta    = [
-                "ext.name":        "csv",
-                "ext.icon24":      "fan://frescoRes/img/iconMissing24.png",
-                "ext.icon72":      "fan://frescoRes/img/iconMissing72.png",
+                "ext.name":        "nrelCsv",
+                "ext.depends":     "io,nrelUtility",
+                "ext.icon":        "table",
                 "org.name":        "NREL",
                 "org.uri":         "https://www.nrel.gov/",
-                "proj.name":       "CSV",
-                "proj.uri":        "https://github.nrel.gov/sfrank1/csvExt",
-                "license.name":    "Commercial",
+                "proj.name":       "NREL CSV Extension",
+                "proj.uri":        "https://github.nrel.gov/IntelligentCampus/nrelCsvExt",
+                "license.name":    "BSD-3",
                 "skyspark.docExt": "true",
               ]
-    depends = ["sys 1.0", "axon 3.0", "ioExt 3.0", "nrelUtilityExt 1.1+"]
-    resDirs = [`locale/`,
-               `lib/`]
-    index   =
-    [
-      "skyarc.ext": "csvExt",
-    ]
+    depends = ["sys 1+", "hx 3.1+"]
+    resDirs = [`lib/`, `locale/`]
+    index   = ["skyarc.ext": "nrelCsvExt"]
   }
+
+  // To publish to StackHub, use: bin/fan /path/to/build.fan publish 
+  // For more information, see: https://skyfoundry.com/doc/stackhub/index#publishing
+
+  //Future Use...
+  //@Target { help = "Publish to stackhub.org " }
+  //Void publish() { stackhub::PublishTask(this).run }
 }