Readme updates (#30)

* Minor change

* Update pyproject toml

* Fix templates

* Update readme

* Remove unused file

* Fix badge

* Correctly comment out lines

* Update action

* Update project name

* Update instructions

* Minor updates

* MInor update

Author: ppinchuk

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -67,7 +67,7 @@ body:
 
     validations:
       required: true
-  - type: input
+  - type: checkboxes
     id: charge-code
     attributes:
       label: Charge code

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -54,7 +54,7 @@ body:
       description: >
         Please provide any relevant GitHub issues, code examples, references, screenshots, or other material
         that help describe and support the feature request.
-  - type: input
+  - type: checkboxes
     id: charge-code
     attributes:
       label: Charge code

.github/workflows/ci-python.yml

@@ -27,7 +27,7 @@ jobs:
 
   locked-tests:
     # needs: lint
-    name: Pixi-Locked Unit Tests
+    name: Pixi-Locked Tests
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -54,7 +54,7 @@ jobs:
 
   tests:
     # needs: lint
-    name: Python Unit Tests (Pixi)
+    name: Python Tests (Pixi)
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false

.github/workflows/publish_to_pypi.yml

@@ -1,8 +1,8 @@
 name: Upload to PyPi
 
 on:
-#   release:
-#     types: [published]
+  release:
+    types: [published]
   workflow_dispatch:
 
 jobs:

README.md

@@ -0,0 +1,72 @@
+******
+reVeal
+******
+
+|License| |Ruff| |Pixi| |SWR|
+
+.. |PythonV| image:: https://badge.fury.io/py/reVeal.svg
+    :target: https://pypi.org/project/reVeal/
+
+.. |PyPi| image:: https://img.shields.io/pypi/pyversions/reVeal.svg
+    :target: https://pypi.org/project/reVeal/
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+
+.. |License| image:: https://img.shields.io/badge/License-BSD_3--Clause-orange.svg
+    :target: https://opensource.org/licenses/BSD-3-Clause
+
+.. |Pixi| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json
+    :target: https://pixi.sh
+
+.. |SWR| image:: https://img.shields.io/badge/SWR--25--147_-blue?label=NLR
+    :alt: Static Badge
+
+.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.17633670.svg
+    :target: https://doi.org/10.5281/zenodo.17633670
+
+.. inclusion-intro
+
+
+``reVeal`` (the reV Extension for Analyzing Large Loads) is an open-source geospatial
+software package for modeling the site-suitability and spatial patterns of deployment
+of large sources of electricity demand under future scenarios. ``reVeal`` is part of
+the `reV ecosystem of tools <https://nrel.github.io/reV/#rev-ecosystem>`_.
+
+
+Installing reVeal
+=================
+The quickest way to install reVeal for users is from PyPI:
+
+.. code-block:: bash
+
+    pip install NLR-reVeal
+
+If you would like to install and run reVeal from source, we recommend using `pixi <https://pixi.sh/latest/>`_:
+
+.. code-block:: bash
+
+    git clone git@github.com:NREL/reVeal.git; cd reVeal
+    pixi run reVeal
+
+For detailed instructions, see the `installation documentation <https://nrel.github.io/reVeal/misc/installation.html>`_.
+
+
+Quickstart
+==========
+.. To run a quick reVeal demo, use:
+
+.. .. code-block:: shell
+
+..     pixi run demo
+
+.. This will generate sample map outputs using example reV geothermal supply curve outputs.
+
+For more information on running ``reVeal``, see
+`Usage <https://github.com/NREL/reVeal/blob/main/USAGE.md>`_.
+
+
+Development
+===========
+Please see the `Development Guidelines <https://nrel.github.io/reVeal/dev/index.html>`_
+if you wish to contribute code to this repository.

README.rst

@@ -6,7 +6,7 @@ requires = [
 build-backend = 'setuptools.build_meta'
 
 [project]
-name = "reVeal"
+name = "NLR-reVeal"
 dynamic = ["version"]
 description = "The reV Extension for Analyzing Large Loads."
 readme = "README.rst"
@@ -130,7 +130,7 @@ rasterio = ">=1.4.4,<2"
 tqdm = ">=4.67.1,<5"
 
 [tool.pixi.pypi-dependencies]
-reVeal = { path = ".", editable = true }
+NLR-reVeal = { path = ".", editable = true }
 
 [tool.pixi.feature.dev.dependencies]
 ipython = ">=8.29.0,<9"
@@ -165,3 +165,57 @@ sphinxcontrib-mermaid = ">=1.0.0,<2"
 python-build = ">=1.3.0,<2"
 pkginfo = ">=1.12.1.2,<2"
 uv = ">=0.9.10,<0.10"
+
+
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+exclude_also = [
+  # Have to re-enable the standard pragma
+  "pragma: no cover",
+
+  # Don't complain about missing debug-only code:
+  "if self\\.debug",
+
+  # Don't complain about repr methods
+  "def __repr__",
+  "def _repr_markdown_",
+
+  # Don't complain about data I/O code
+  "def load*",
+  "def _load*",
+
+  # Don't complain if tests don't hit defensive assertion code:
+  "raise AssertionError",
+  "raise NotImplementedError",
+
+  # Don't complain if non-runnable code isn't run:
+  "if __name__ == .__main__.:",
+
+  # Don't complain about abstract methods, they aren't run:
+  "@(abc\\.)?abstractmethod",
+
+  # Don't complain about logging debugging functions
+  "def print_logging_info*",
+  "def __cls_name",
+]
+
+omit = [
+  # omit test files
+  "tests/*",
+  # omit init files
+  "__init__.py",
+  # omit version file
+  "_version.py",
+  # omit log file copied over from other repo
+  "reVeal/log.py",
+  # omit pixi files
+  ".pixi/*",
+]
+
+
+[tool.pytest.ini_options]
+addopts = "--disable-warnings"
+testpaths = [
+  "tests"
+]
+markers = "skip_ci: marks test as one that should not be run on GitHub Workflows"