Refactor project to rename from NREL-farms to NLR-farms and update re…

.github/workflows/pull_request_tests.yml

@@ -20,10 +20,11 @@ jobs:
             python-version: '3.9'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         ref: ${{ github.event.pull_request.head.ref }}
-        fetch-depth: 1
+        fetch-depth: 0
+        fetch-tags: true
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:

README.rst

@@ -2,29 +2,23 @@
 Welcome to the Fast All-sky Radiation Model for Solar applications (FARMS)!
 ***************************************************************************
 
-.. image:: https://github.com/NREL/farms/workflows/Documentation/badge.svg
+.. image:: https://github.com/NatLabRockies/farms/workflows/Documentation/badge.svg
     :target: https://nrel.github.io/farms/
 
-.. image:: https://github.com/NREL/farms/workflows/Pytests/badge.svg
-    :target: https://github.com/NREL/farms/actions?query=workflow%3A%22Pytests%22
+.. image:: https://github.com/NatLabRockies/farms/workflows/Pytests/badge.svg
+    :target: https://github.com/NatLabRockies/farms/actions?query=workflow%3A%22Pytests%22
 
-.. image:: https://github.com/NREL/farms/workflows/Lint%20Code%20Base/badge.svg
-    :target: https://github.com/NREL/farms/actions?query=workflow%3A%22Lint+Code+Base%22
+.. image:: https://github.com/NatLabRockies/farms/workflows/Lint%20Code%20Base/badge.svg
+    :target: https://github.com/NatLabRockies/farms/actions?query=workflow%3A%22Lint+Code+Base%22
 
-.. image:: https://img.shields.io/pypi/pyversions/NREL-farms.svg
-    :target: https://pypi.org/project/NREL-farms/
+.. image:: https://img.shields.io/pypi/pyversions/NLR-farms.svg
+    :target: https://pypi.org/project/NLR-farms/
 
-.. image:: https://badge.fury.io/py/NREL-farms.svg
-    :target: https://badge.fury.io/py/NREL-farms
+.. image:: https://badge.fury.io/py/NLR-farms.svg
+    :target: https://badge.fury.io/py/NLR-farms
 
-.. image:: https://anaconda.org/nrel/nrel-farms/badges/version.svg
-    :target: https://anaconda.org/nrel/nrel-farms
-
-.. image:: https://anaconda.org/nrel/nrel-farms/badges/license.svg
-    :target: https://anaconda.org/nrel/nrel-farms
-
-.. image:: https://codecov.io/gh/nrel/farms/branch/master/graph/badge.svg?token=WQ95L11SRS
-    :target: https://codecov.io/gh/nrel/farms
+.. image:: https://codecov.io/gh/NatLabRockies/farms/branch/master/graph/badge.svg?token=WQ95L11SRS
+    :target: https://codecov.io/gh/NatLabRockies/farms
 
 
 The Fast All-sky Radiation Model for Solar applications (FARMS) is used to
@@ -35,26 +29,25 @@ compute cloudy irradiance.
 Installing farms
 ================
 
-Option 1: Install from PIP or Conda (recommended for analysts):
----------------------------------------------------------------
+Option 1: Install from PyPI (recommended for analysts):
+-------------------------------------------------------
 
 1. Create a new environment:
     ``conda create --name farms``
 
-2. Activate directory:
+2. Activate the environment:
     ``conda activate farms``
 
 3. Install farms:
-    1) ``pip install NREL-farms`` or
-    2) ``conda install nrel-farms --channel=nrel``
+    ``pip install NLR-farms``
 
 Option 2: Clone repo (recommended for developers)
 -------------------------------------------------
 
-1. Create ``farms`` environment and install package
+1. Create an environment and install package
     1) Create a conda env: ``conda create -n farms``
     2) Run the command: ``conda activate farms``
-    3) cd into the repo cloned in 1.
+    3) Clone the repository and ``cd`` into it.
     4) prior to running ``pip`` below, make sure the branch is correct (install
        from master!)
     5) Install ``farms`` and its dependencies by running:

docs/README.md

@@ -8,11 +8,7 @@ See their documentation for (a lot) more details.
 To generate the docs yourself, you'll need the appropriate package:
 
 ```
-conda install sphinx
-conda install sphinx_rtd_theme
-
-pip install ghp-import
-pip install sphinx-click
+python -m pip install sphinx sphinx_rtd_theme ghp-import sphinx-click
 ```
 
 ## Refreshing the API Documentation

docs/source/conf.py

@@ -28,7 +28,7 @@
 pkg = os.path.dirname(pkg)
 sys.path.append(pkg)
 
-with open(os.path.join(pkg, "farms", "version.py"), encoding="utf-8") as f:
+with open(os.path.join(pkg, "farms", "_version.py"), encoding="utf-8") as f:
     v = f.read()
 
 v = v.split("=")[-1].strip().strip('"').strip("'")
@@ -109,7 +109,7 @@
 
 html_context = {
     "display_github": True,
-    "github_user": "nrel",
+    "github_user": "NatLabRockies",
     "github_repo": "farms",
     "github_version": "main",
     "conf_py_path": "/docs/source/",

farms/__init__.py

@@ -25,7 +25,7 @@
 
 import pandas as pd
 
-from .version import __version__
+from ._version import __version__
 
 FARMSDIR = os.path.dirname(os.path.realpath(__file__))
 

farms/farms.py

@@ -5,7 +5,7 @@
 @author: Anthony Lopez
 
 This Fast All-sky Radiation Model for Solar applications (FARMS) was developed
-by Yu Xie (Yu.Xie@nrel.gov). Please contact him for more information.
+by Yu Xie (Yu.Xie@nlr.gov). Please contact him for more information.
 
 Literature
 ----------

pyproject.toml

@@ -6,14 +6,14 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "NREL-farms"
+name = "NLR-farms"
 dynamic = ["version"]
 description = "The Fast All-sky Radiation Model for Solar applications (FARMS)"
 keywords = ["farms", "NREL"]
 readme = "README.rst"
 authors = [
-  {name = "Brandon Benton", email = "brandon.benton@nrel.gov"},
-  {name = "Grant Buster", email = "grant.buster@nrel.gov"}
+  {name = "Brandon Benton", email = "brandon.benton@nlr.gov"},
+  {name = "Grant Buster", email = "grant.buster@nlr.gov"}
 ]
 license = {text = "BSD-3-Clause"}
 requires-python = ">= 3.9"
@@ -49,9 +49,9 @@ test = [
 ]
 
 [project.urls]
-homepage = "https://github.com/NREL/farms"
+homepage = "https://github.com/NatLabRockies/farms"
 documentation = "https://nrel.github.io/farms/"
-repository = "https://github.com/NREL/farms"
+repository = "https://github.com/NatLabRockies/farms"
 
 [tool.ruff]
 line-length = 79
@@ -168,3 +168,4 @@ packages = ["farms"]
 
 [tool.setuptools_scm]
 version_file = "farms/_version.py"
+version_scheme = "guess-next-dev"