Update documentation ahead of v0.9 release

CHANGELOG.md

@@ -1,4 +1,4 @@
-## Unreleased
+## v0.9 (DAY MONTH YEAR)
 
 ### Bug Fixes
 
@@ -31,6 +31,7 @@
 ### Deprecations
 
 - The original library structure has been fully deprecated, please see the Reference/How To example for more details on converting data that has not yet been updated.
+- All PySAM functionality has been deprecated as it's no longer relevant to this work.
 - The `Simulation.config` no longer requires the `library` field to reduce conflicts with sharing data between users.
 
 ## v0.8.1 (28 August 2023)

LICENSE

@@ -1,5 +1,3 @@
-Copyright (c) 2020 Alliance for Sustainable Energy, LLC
-
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

NOTICE

@@ -0,0 +1,12 @@
+Copyright 2021 Alliance for Sustainable Energy, LLC
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

docs/jupyter_execute/examples/how_to.ipynb

@@ -2,7 +2,7 @@
   "cells": [
     {
       "cell_type": "markdown",
-      "id": "7fc99988",
+      "id": "2ff898a7",
       "metadata": {},
       "source": [
         "# How To Use WOMBAT\n",
@@ -19,7 +19,7 @@
     {
       "cell_type": "code",
       "execution_count": 1,
-      "id": "71b64545",
+      "id": "4a3b63be",
       "metadata": {},
       "outputs": [],
       "source": [
@@ -42,7 +42,7 @@
     },
     {
       "cell_type": "markdown",
-      "id": "d90c3ca1",
+      "id": "9c2d949a",
       "metadata": {},
       "source": [
         "## Defining the Simulation\n",
@@ -489,7 +489,7 @@
     {
       "cell_type": "code",
       "execution_count": 2,
-      "id": "1c4243b4",
+      "id": "fd129270",
       "metadata": {},
       "outputs": [],
       "source": [
@@ -498,7 +498,7 @@
     },
     {
       "cell_type": "markdown",
-      "id": "79c118a1",
+      "id": "4de028f0",
       "metadata": {},
       "source": [
         "### The configuration file\n",
@@ -519,7 +519,7 @@
     {
       "cell_type": "code",
       "execution_count": 3,
-      "id": "d1d8ca1f",
+      "id": "50f2953a",
       "metadata": {},
       "outputs": [],
       "source": [
@@ -528,7 +528,7 @@
     },
     {
       "cell_type": "markdown",
-      "id": "b44b7ebf",
+      "id": "9dde4398",
       "metadata": {},
       "source": [
         "```{code-block} yaml\n",
@@ -571,7 +571,7 @@
     {
       "cell_type": "code",
       "execution_count": 4,
-      "id": "206941f8",
+      "id": "5bdd6a85",
       "metadata": {},
       "outputs": [],
       "source": [
@@ -583,7 +583,7 @@
     },
     {
       "cell_type": "markdown",
-      "id": "ded5b413",
+      "id": "a5d882b2",
       "metadata": {},
       "source": [
         "### Option 2: `Simulation()`\n",
@@ -605,7 +605,7 @@
     {
       "cell_type": "code",
       "execution_count": 5,
-      "id": "d3bf734e",
+      "id": "5214aa46",
       "metadata": {},
       "outputs": [],
       "source": [
@@ -618,7 +618,7 @@
     },
     {
       "cell_type": "markdown",
-      "id": "1349aa73",
+      "id": "812eaba4",
       "metadata": {},
       "source": [
         "### Seeding the simulation random variable\n",
@@ -631,7 +631,7 @@
     {
       "cell_type": "code",
       "execution_count": 6,
-      "id": "4b8c14ba",
+      "id": "b01c06ba",
       "metadata": {},
       "outputs": [],
       "source": [
@@ -652,7 +652,7 @@
     },
     {
       "cell_type": "markdown",
-      "id": "31039992",
+      "id": "c20dddf0",
       "metadata": {},
       "source": [
         "## Run the analysis\n",
@@ -667,7 +667,7 @@
     {
       "cell_type": "code",
       "execution_count": 7,
-      "id": "50d2ff1a",
+      "id": "fc4df98d",
       "metadata": {},
       "outputs": [
         {
@@ -692,7 +692,7 @@
     },
     {
       "cell_type": "markdown",
-      "id": "6c6f6cb1",
+      "id": "3d09a90b",
       "metadata": {},
       "source": [
         "## Metric computation\n",
@@ -704,7 +704,7 @@
     {
       "cell_type": "code",
       "execution_count": 8,
-      "id": "2c55db0a",
+      "id": "6deb1d73",
       "metadata": {},
       "outputs": [
         {
@@ -726,7 +726,7 @@
     {
       "cell_type": "code",
       "execution_count": 9,
-      "id": "7a327086",
+      "id": "edeed2f8",
       "metadata": {},
       "outputs": [
         {
@@ -753,7 +753,7 @@
     },
     {
       "cell_type": "markdown",
-      "id": "2ca5e1b6",
+      "id": "466cf8c2",
       "metadata": {},
       "source": [
         "## Optional: Delete the logging files\n",
@@ -764,7 +764,7 @@
     {
       "cell_type": "code",
       "execution_count": 10,
-      "id": "adf7fe24",
+      "id": "c43744a5",
       "metadata": {},
       "outputs": [],
       "source": [