Skip to content

Commit 54e9753

Browse files
bnb32bnb32
authored
Merge pull request #71 from NatLabRockies/bnb/nlr
chore: update project references from NREL to NLR and adjust document…
2 parents 87be189 + 2df8890 commit 54e9753

11 files changed

Lines changed: 44 additions & 125 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ If applicable, add screenshots to help explain your problem.
4343
Add any other context about the problem here.
4444

4545
**Charge code**
46-
If you are at NREL and fixing this bug is urgent, please provide a charge code for our time.
46+
If you are at NLR and fixing this bug is urgent, please provide a charge code for our time.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ A clear and concise description of any alternative solutions or features you've
2020
Add any other context or screenshots about the feature request here.
2121

2222
**Charge code**
23-
If you are at NREL, please provide a task number for the developers to implement this feature.
23+
If you are at NLR, please provide a task number for the developers to implement this feature.
2424

2525
**Urgency / Timeframe**
2626
When do you need this feature by? How urgent is it related to other feature requests you've made?

‎.github/workflows/conda_build.yml‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎.github/workflows/publish_to_pypi.yml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ jobs:
1414
steps:
1515
- uses: actions/checkout@v4
1616
with:
17-
ref: ${{ github.event.pull_request.head.ref }}
1817
fetch-depth: 0
1918
fetch-tags: true
2019
- name: Set up Python
@@ -24,11 +23,10 @@ jobs:
2423
- name: Install dependencies and Build
2524
run: |
2625
python -m pip install --upgrade pip
27-
pip install setuptools build
26+
pip install build twine
2827
python -m build --sdist --wheel --outdir dist/ .
2928
- name: Check distribution files
3029
run: |
31-
pip install twine
32-
twine check dist/*
30+
python -m twine check dist/*
3331
- name: Publish
3432
uses: pypa/gh-action-pypi-publish@release/v1

‎.github/workflows/pull_request_tests_tf_latest.yml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@ jobs:
2222
- os: ubuntu-latest
2323
python-version: 3.8
2424
steps:
25-
- uses: actions/checkout@v2
25+
- uses: actions/checkout@v4
2626
with:
2727
ref: ${{ github.event.pull_request.head.ref }}
28+
fetch-depth: 0
29+
fetch-tags: true
2830
- name: Set up Python ${{ matrix.python-version }}
29-
uses: actions/setup-python@v2
31+
uses: actions/setup-python@v4
3032
with:
3133
python-version: ${{ matrix.python-version }}
3234
- name: Install dependencies

‎README.rst‎

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,29 @@
22
phygnn
33
######
44

5-
.. image:: https://github.com/NREL/phygnn/workflows/Documentation/badge.svg
6-
:target: https://nrel.github.io/phygnn/
5+
.. image:: https://github.com/NatLabRockies/phygnn/workflows/Documentation/badge.svg
6+
:target: https://natlabrockies.github.io/phygnn/
77

8-
.. image:: https://github.com/NREL/phygnn/workflows/pytests_tf_latest/badge.svg
9-
:target: https://github.com/NREL/phygnn/actions?query=workflow%3A%22pytests_tf_latest%22
8+
.. image:: https://github.com/NatLabRockies/phygnn/workflows/pytests_tf_latest/badge.svg
9+
:target: https://github.com/NatLabRockies/phygnn/actions?query=workflow%3A%22pytests_tf_latest%22
1010

11-
.. image:: https://github.com/NREL/phygnn/workflows/Lint%20Code%20Base/badge.svg
12-
:target: https://github.com/NREL/phygnn/actions?query=workflow%3A%22Lint+Code+Base%22
11+
.. image:: https://github.com/NatLabRockies/phygnn/workflows/Lint%20Code%20Base/badge.svg
12+
:target: https://github.com/NatLabRockies/phygnn/actions?query=workflow%3A%22Lint+Code+Base%22
1313

14-
.. image:: https://img.shields.io/pypi/pyversions/nrel-phygnn.svg
15-
:target: https://pypi.org/project/nrel-phygnn/
14+
.. image:: https://img.shields.io/pypi/pyversions/nlr-phygnn.svg
15+
:target: https://pypi.org/project/nlr-phygnn/
1616

17-
.. image:: https://badge.fury.io/py/NREL-phygnn.svg
18-
:target: https://badge.fury.io/py/NREL-phygnn
17+
.. image:: https://badge.fury.io/py/NLR-phygnn.svg
18+
:target: https://badge.fury.io/py/NLR-phygnn
1919

20-
.. image:: https://anaconda.org/nrel/nrel-phygnn/badges/version.svg
21-
:target: https://anaconda.org/nrel/nrel-phygnn
22-
23-
.. image:: https://anaconda.org/nrel/nrel-phygnn/badges/license.svg
24-
:target: https://anaconda.org/nrel/nrel-phygnn
25-
26-
.. image:: https://codecov.io/gh/nrel/phygnn/branch/master/graph/badge.svg?token=ZJFQWAAM1N
27-
:target: https://codecov.io/gh/nrel/phygnn
20+
.. image:: https://codecov.io/gh/NatLabRockies/phygnn/branch/main/graph/badge.svg?token=ZJFQWAAM1N
21+
:target: https://codecov.io/gh/NatLabRockies/phygnn
2822

2923
.. image:: https://zenodo.org/badge/276492167.svg
3024
:target: https://zenodo.org/badge/latestdoi/276492167
3125

3226
.. image:: https://mybinder.org/badge_logo.svg
33-
:target: https://mybinder.org/v2/gh/NREL/PHYGNN/HEAD
27+
:target: https://mybinder.org/v2/gh/NatLabRockies/phygnn/HEAD
3428

3529

3630
**phygnn** (fi-geon | \ ˈfi-jən) noun.
@@ -49,15 +43,15 @@ applications, such as when machine learning models produce physically
4943
inconsistent results or have trouble generalizing to out-of-sample scenarios.
5044

5145
For details on the phygnn class framework see `the phygnn class documentation
52-
here. <https://nrel.github.io/phygnn/_autosummary/phygnn.phygnn.PhysicsGuidedNeuralNetwork.html>`_
46+
here. <https://natlabrockies.github.io/phygnn/_autosummary/phygnn.phygnn.PhysicsGuidedNeuralNetwork.html>`_
5347

5448
For example notebooks using the phygnn architecture for regression,
5549
classification, and even GAN applications, see `the example notebooks here
56-
<https://github.com/NREL/phygnn/tree/master/examples>`_.
50+
<https://github.com/NatLabRockies/phygnn/tree/main/examples>`_.
5751
You can also run the examples using a free cloud-hosted jupyter instance via
58-
`Binder <https://mybinder.org/v2/gh/NREL/PHYGNN/HEAD>`_.
52+
`Binder <https://mybinder.org/v2/gh/NatLabRockies/phygnn/HEAD>`_.
5953

60-
At the National Renewable Energy Lab (NREL), we are using the phygnn framework
54+
At NLR, we are using the phygnn framework
6155
to supplement traditional satellite-based cloud property prediction models. We
6256
use phygnn to predict cloud optical properties when the traditional mechanistic
6357
models fail and use a full tensor-based radiative transfer model as the
@@ -91,7 +85,7 @@ Suggested Citation
9185

9286
Update with current version and DOI:
9387

94-
Grant Buster, Michael Rossol, Mike Bannister, and Dylan Hettinger. Physics-Guided Neural Networks (phygnn). https://github.com/NREL/phygnn (version v0.0.9), 2021. https://doi.org/10.5281/zenodo.4498541.
88+
Grant Buster, Michael Rossol, Mike Bannister, and Dylan Hettinger. Physics-Guided Neural Networks (phygnn). https://github.com/NatLabRockies/phygnn (version v0.0.34), 2021. https://doi.org/10.5281/zenodo.4498541.
9589

9690

9791
Installation
@@ -103,21 +97,20 @@ Simple Install
10397

10498
1. Use conda (anaconda or miniconda) to create a phygnn environment: ``conda create --name phygnn python=3.9``
10599

106-
i. Note that phygnn is tested with python >= 3.8 via pip install. Users have reported issues installing phygnn using conda install.
100+
i. Note that phygnn is tested with python >= 3.8 via pip install.
107101

108102
2. Activate your new conda env: ``conda activate phygnn``
109-
3. Install with pip or conda:
103+
3. Install with pip:
110104

111-
i. ``pip install NREL-phygnn``
112-
ii. ``conda install -c nrel nrel-phygnn``
105+
i. ``pip install NLR-phygnn``
113106

114107

115108
Developer Install
116109
-----------------
117110

118111
1. Use conda (anaconda or miniconda) to create a phygnn environment: ``conda create --name phygnn python=3.9``
119112
2. Activate your new conda env: ``conda activate phygnn``
120-
3. Clone the phygnn repository: ``git clone git@github.com:NREL/phygnn.git``
113+
3. Clone the phygnn repository: ``git clone git@github.com:NatLabRockies/phygnn.git``
121114
4. Navigate to the cloned repo and checkout your desired branch: ``git checkout main`` or ``git checkout <branch>``
122115
5. Navigate to the phygnn directory that contains setup.py and run: ``pip install -e .`` (developer install) or ``pip install .`` (static install).
123116
6. Test your installation:

‎conda.recipe/meta.yaml‎

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎conda_build.sh‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎docs/source/conf.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
# -- Project information -----------------------------------------------------
2424

2525
project = 'phygnn'
26-
copyright = '2020, Alliance for Sustainable Energy, LLC'
27-
author = 'NREL: Grant Buster, Michael Rossol, Mike Bannister, Dylan Hettinger'
26+
copyright = '2020, Alliance for Energy Innovation, LLC'
27+
author = 'NLR: Grant Buster, Michael Rossol, Mike Bannister, Dylan Hettinger'
2828

2929
pkg = os.path.dirname(os.path.abspath(os.path.dirname(__file__)))
3030
pkg = os.path.dirname(pkg)
@@ -113,7 +113,7 @@
113113

114114
html_context = {
115115
"display_github": True,
116-
"github_user": "nrel",
116+
"github_user": "NatLabRockies",
117117
"github_repo": "phygnn",
118118
"github_version": "main",
119119
"conf_py_path": "/docs/source/",

‎phygnn/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
get_custom_objects()['GaussianAveragePooling2D'] = GaussianAveragePooling2D
1717

1818
__author__ = """Grant Buster"""
19-
__email__ = 'grant.buster@nrel.gov'
19+
__email__ = 'grant.buster@nlr.gov'
2020

2121
PHYGNNDIR = os.path.dirname(os.path.realpath(__file__))
2222
TESTDATADIR = os.path.join(os.path.dirname(PHYGNNDIR), 'tests', 'data')

0 commit comments

Comments
 (0)