Reorganize docs

docs/source/citation-attribution.rst

@@ -0,0 +1,96 @@
+.. _citation-attribution:
+
+######################
+Citation & Attribution
+######################
+
+This page provides guidelines for citing dsgrid and datasets produced using
+the toolkit.
+
+Citing the dsgrid Toolkit
+=========================
+
+When using the dsgrid toolkit in your research, please cite:
+
+.. code-block:: bibtex
+
+    @software{dsgrid,
+      author = {NREL dsgrid Team},
+      title = {dsgrid: Demand-Side Grid Toolkit},
+      url = {https://github.com/dsgrid/dsgrid},
+      institution = {National Renewable Energy Laboratory}
+    }
+
+Citing dsgrid Datasets
+======================
+
+Each published dataset has its own citation requirements. When using data from
+a dsgrid project:
+
+1. **Cite the specific dataset** using the DOI provided in the
+   :doc:`published datasets catalog </data/published-datasets>`
+
+2. **Cite the dsgrid toolkit** (see above)
+
+3. **Acknowledge underlying data sources** as appropriate (e.g., ResStock,
+   ComStock, TEMPO)
+
+Example Dataset Citation
+------------------------
+
+.. code-block:: bibtex
+
+    @techreport{dsgrid_standard_scenarios_2024,
+      title = {Standard Scenarios 2024: Hourly Electricity Load Profiles},
+      author = {NREL dsgrid Team},
+      institution = {National Renewable Energy Laboratory},
+      year = {2024},
+      doi = {10.XXXX/XXXXX}
+    }
+
+Acknowledging Underlying Data
+=============================
+
+dsgrid datasets typically integrate data from multiple sources. When using
+dsgrid data, please also acknowledge the underlying data sources:
+
+**ResStock**
+   Residential building energy model data. See
+   `ResStock documentation <https://resstock.readthedocs.io/>`_ for citation
+   requirements.
+
+**ComStock**
+   Commercial building energy model data. See
+   `ComStock documentation <https://nrel.github.io/ComStock.github.io/>`_ for
+   citation requirements.
+
+**TEMPO**
+   Transportation electrification projections. Contact the dsgrid team for
+   citation requirements.
+
+**Other Sources**
+   Check the documentation for specific datasets for additional attribution
+   requirements.
+
+License
+=======
+
+dsgrid is open-source software released under the BSD 3-Clause License.
+
+Published datasets may have their own licensing terms. Check the documentation
+for each dataset for specific license information.
+
+Questions
+=========
+
+For questions about citation or attribution:
+
+- :doc:`Contact the dsgrid team </contact>`
+- `GitHub Discussions <https://github.com/dsgrid/dsgrid/discussions>`_
+
+See Also
+========
+
+- :doc:`publications` - Related publications
+- :doc:`data/published-datasets` - Available datasets
+- :doc:`contact` - Get in touch

docs/source/conf.py

@@ -48,6 +48,7 @@
     "sphinx_click",
     "sphinxcontrib.autodoc_pydantic",
     "sphinx_tabs.tabs",
+    "sphinx_design",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -111,5 +112,5 @@
 autodoc_pydantic_model_show_json = False
 autodoc_pydantic_model_show_config_member = False
 autodoc_pydantic_model_show_config_summary = False
-autodoc_pydantic_model_erdantic_figure = True
+autodoc_pydantic_model_erdantic_figure = False
 autodoc_pydantic_model_erdantic_figure_collapsed = False

docs/source/contact.rst

@@ -0,0 +1,91 @@
+.. _contact:
+
+#######
+Contact
+#######
+
+This page provides information on how to get in touch with the dsgrid team.
+
+General Inquiries
+=================
+
+For general questions about dsgrid:
+
+- Visit the `NREL dsgrid website <https://www.nrel.gov/analysis/dsgrid.html>`_
+- Email the dsgrid coordination team (contact information available on the NREL
+  website)
+
+Technical Support
+=================
+
+For technical questions and issues:
+
+**GitHub Issues**
+   Report bugs, request features, or ask technical questions:
+   `dsgrid Issues <https://github.com/dsgrid/dsgrid/issues>`_
+
+**GitHub Discussions**
+   For general technical discussions and questions:
+   `dsgrid Discussions <https://github.com/dsgrid/dsgrid/discussions>`_
+
+**Documentation**
+   Many questions are answered in the documentation:
+
+   - :doc:`Getting Started </getting-started/index>` - User-type specific guides
+   - :doc:`How-To Guides </how_tos/index>` - Common workflows
+   - :doc:`Tutorials </tutorials/index>` - Step-by-step examples
+   - :doc:`Fundamentals </fundamentals/index>` - Technical deep-dives
+
+Data Access
+===========
+
+For questions about accessing dsgrid data:
+
+- :doc:`Published Datasets </data/published-datasets>` - Available datasets
+- :doc:`Current Projects </projects/current-projects>` - Active and completed projects
+- :doc:`Getting Started for Data Users </getting-started/for-data-users>` - Quick path to data
+
+Dataset Submission
+==================
+
+For questions about contributing data to dsgrid:
+
+- :doc:`Getting Started for Dataset Submitters </getting-started/for-dataset-submitters>`
+  - Submission workflow
+- :doc:`Create and Submit Dataset Tutorial </tutorials/create_and_submit_dataset>`
+  - Step-by-step guide
+
+Contact your project coordinator for project-specific submission requirements.
+
+Collaboration
+=============
+
+For collaboration opportunities:
+
+- **Dataset contributions**: If your organization has relevant datasets
+- **Custom projects**: Tailored analyses for specific needs
+- **Research partnerships**: Collaborative research and development
+
+Contact the dsgrid coordination team through the NREL website to discuss
+opportunities.
+
+Feedback
+========
+
+We welcome feedback on:
+
+- Documentation improvements
+- Feature requests
+- Bug reports
+- General suggestions
+
+Use `GitHub Issues <https://github.com/dsgrid/dsgrid/issues>`_ or
+`GitHub Discussions <https://github.com/dsgrid/dsgrid/discussions>`_ to
+share your feedback.
+
+See Also
+========
+
+- :doc:`publications` - Related publications
+- :doc:`citation-attribution` - How to cite dsgrid
+- `NREL dsgrid website <https://www.nrel.gov/analysis/dsgrid.html>`_

docs/source/data/index.rst

@@ -0,0 +1,113 @@
+.. _data:
+
+####
+Data
+####
+
+This section covers everything related to accessing, understanding, and working
+with dsgrid data.
+
+.. grid:: 2
+    :gutter: 3
+
+    .. grid-item-card:: Published Datasets
+        :link: published-datasets
+        :link-type: doc
+
+        Browse the catalog of published dsgrid datasets available for download
+        and analysis.
+
+    .. grid-item-card:: Querying Data
+        :link: querying-data
+        :link-type: doc
+
+        Learn how to write queries to extract exactly the data you need from
+        dsgrid projects.
+
+    .. grid-item-card:: Mapping Data
+        :link: mapping-data
+        :link-type: doc
+
+        Transform data across dimensions, geographies, and time conventions.
+
+    .. grid-item-card:: Input Datasets
+        :link: input-datasets/index
+        :link-type: doc
+
+        Requirements and formats for contributing datasets to dsgrid projects.
+
+Data Overview
+=============
+
+dsgrid manages multi-dimensional timeseries data describing electricity demand
+and other energy metrics. Data is organized in a hierarchical structure:
+
+**Projects**
+   Top-level containers that define scope (geography, time period, sectors)
+   and coordinate multiple datasets.
+
+**Datasets**
+   Individual data contributions from various sources (models, surveys,
+   historical data) that are mapped to project dimensions.
+
+**Derived Datasets**
+   Created by combining, transforming, or querying project datasets.
+
+Data Dimensions
+---------------
+
+All dsgrid data is organized along these dimension types:
+
+- **Geography**: Spatial resolution (counties, states, regions, etc.)
+- **Time**: Temporal resolution (hourly, daily, monthly, annual)
+- **Sector**: Economic sectors (residential, commercial, industrial, transportation)
+- **Subsector**: Detailed categorizations within sectors
+- **Metric**: What is being measured (energy, power, emissions, etc.)
+- **Scenario**: Future pathways or policy scenarios
+- **Model Year**: Projection years for forward-looking analysis
+- **Weather Year**: Historical weather patterns used in simulations
+
+See :doc:`Dimensions </explanations/components/dimensions>` for detailed documentation.
+
+Data Access Patterns
+====================
+
+**For quick analysis:**
+   Download pre-computed datasets from the :doc:`published datasets <published-datasets>`
+   catalog.
+
+**For custom queries:**
+   Use the dsgrid CLI or Python API to :doc:`query <querying-data>` specific data subsets.
+
+**For data contribution:**
+   Follow the :doc:`input datasets <input-datasets/index>` guide to prepare and
+   submit your data.
+
+Quick Links
+===========
+
+**Access Data:**
+
+- :doc:`Published Datasets <published-datasets>` - Download ready-to-use data
+- :doc:`Current Projects </projects/current-projects>` - View active projects
+- :doc:`Query Data <querying-data>` - Extract custom subsets
+
+**Understand Data:**
+
+- :doc:`Data Formats </reference/dataset_formats>` - File format specifications
+- :doc:`Dimensions </explanations/components/dimensions>` - Dimension types and records
+- :doc:`Datasets </explanations/components/datasets>` - Dataset structure
+
+**Contribute Data:**
+
+- :doc:`Input Datasets <input-datasets/index>` - Submission requirements
+- :doc:`Dataset Submission Guide </getting-started/for-dataset-submitters>` - Step-by-step workflow
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   published-datasets
+   querying-data
+   mapping-data
+   input-datasets/index