Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codecov.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Codecov configuration for ilaflott/fremorizer
# Codecov configuration for NOAA-GFDL/fremorizer
# Reference: https://docs.codecov.com/docs/codecovyml-reference

coverage:
Expand Down
2 changes: 1 addition & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@
"cspell.json",
"*.cdl",
"build",
"fremorizer.egg-info"
"fremor.egg-info"
]
}
41 changes: 0 additions & 41 deletions .github/PULL_REQUEST_TEMPLATE/release_procedure.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/agents/tester.agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: runs, writes, and reports on tests in this repository when asked to

# My Agent

- leverages fremorizer's packaging to spin up virtual conda environments for easy testing.
- leverages fremor's packaging to spin up virtual conda environments for easy testing.
- is also an expert in python, packaging, conda, and testing concerns specific to those two concepts.
- specializes in testing a local checkout of the code via editable installs
- specializes in testing context within conda build
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish_conda.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
activate-environment: base
conda-remove-defaults: true
miniforge-version: latest
channels: conda-forge,noaa-gfdl,ilaflott
channels: conda-forge,noaa-gfdl

- name: Configure Conda
run: |
Expand All @@ -49,5 +49,5 @@ jobs:
- name: Build fremor Conda Package
run: |
echo "conda building fremor package"
export ANACONDA_API_TOKEN=${{ secrets.TEMP_ANACONDA_API_TOKEN }}
export ANACONDA_API_TOKEN=${{ secrets.ANACONDA_API_TOKEN }}
conda build .
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[submodule "fremorizer/tests/test_files/cmip6-cmor-tables"]
[submodule "fremor/tests/test_files/cmip6-cmor-tables"]
path = fremor/tests/test_files/cmip6-cmor-tables
url = https://github.com/pcmdi/cmip6-cmor-tables.git
[submodule "fremorizer/tests/test_files/cmip7-cmor-tables"]
[submodule "fremor/tests/test_files/cmip7-cmor-tables"]
path = fremor/tests/test_files/cmip7-cmor-tables
url = https://github.com/WCRP-CMIP/cmip7-cmor-tables.git
branch = DR-1.2.2.3-v1.0.5
6 changes: 4 additions & 2 deletions CODE_STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Disclaimer: This style guide is still in development.

Follow these Style Guidelines when contributing to the `fremorizer` repository.
Follow these Style Guidelines when contributing to the `fremor` repository.

## Code Checklist

Expand Down Expand Up @@ -47,7 +47,7 @@ Annotations are described in [PEP 3107](https://peps.python.org/pep-3107/).

Useful Resources
- https://docs.python.org/3/library/typing.html
- https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html (Note: fremorizer is not dependent on mypy)
- https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html (Note: fremor is not dependent on mypy)
- https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#field-lists
- https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

Expand All @@ -66,6 +66,8 @@ class MyClass(object):
:ivar str var2: description, initial value: par2
"""

# space after the pound for a comment
# single quotes for in-body quoted objects, e.g. the next line
var3: ClassVar[str] = 'I am a class variable'

def __init__(self, par1: int, par2: int):
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## **For Developers**

* Developers are free to use this repository's `README.md` to familiarize with the CLI and save time from having to install any dependencies, but development within a Conda environment is heavily recommended regardless
* Gain access to the repository with `git clone --recursive git@github.com:ilaflott/fremorizer.git` or your fork's link (recommended) and an SSH RSA key
- Once inside the repository, developers can test local changes by running a `pip install .` inside of the root directory after activating a virtual environment, installing the fremorizer package locally with the newest local changes on top of the installed Conda fremorizer dependencies. the `-e` flag can be used for an editable installation
* Gain access to the repository with `git clone --recursive git@github.com:NOAA-GFDL/fremor.git` or your fork's link (recommended) and an SSH RSA key
- Once inside the repository, developers can test local changes by running a `pip install .` inside of the root directory after activating a virtual environment, installing the fremor package locally with the newest local changes on top of the installed Conda fremor dependencies. the `-e` flag can be used for an editable installation
- Test as a normal user would use the CLI
* Create a GitHub issue to reflect your contribution's background and reference it with Git commits

Expand All @@ -13,10 +13,10 @@ With few exceptions, pull requests always require an issue.
### **Adding Tools From Other Repositories**

* Currently, the solution to this task is to approach it using Conda packages. The tool that is being added must reside within a repository that contains a meta.yaml that includes Conda dependencies like the one in this repository and ideally a setup.py (may be subject to change due to deprecation) that may include any potentially needed pip dependencies
- Once published as a Conda package, ideally on the [NOAA-GFDL channel](https://anaconda.org/NOAA-GFDL), an addition can be made to the "run" section under the "requirements" category in the meta.yaml of the fremorizer following the syntax `channel::package`
- On pushes to the main branch, the [package](https://anaconda.org/ilaflott/fremorizer) will automatically be updated using the workflow file
- Once published as a Conda package, ideally on the [NOAA-GFDL channel](https://anaconda.org/NOAA-GFDL), an addition can be made to the "run" section under the "requirements" category in the meta.yaml of the fremor following the syntax `channel::package`
- On pushes to the main branch, the [package](https://anaconda.org/NOAA-GFDL/fremor) will automatically be updated using the workflow file

### **MANIFEST.in**

* In the case where non-python files like templates, examples, and outputs are to be included in the fremorizer package, MANIFEST.in can provide the solution. Ensure that the file exists within the correct folder, and add a line to the MANIFEST.in following [this syntax](https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html)
* In the case where non-python files like templates, examples, and outputs are to be included in the fremor package, MANIFEST.in can provide the solution. Ensure that the file exists within the correct folder, and add a line to the MANIFEST.in following [this syntax](https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html)

Loading
Loading