From 6c8c4b8f7b14a8d3618cf35952237acae4a16099 Mon Sep 17 00:00:00 2001 From: mgrover1 Date: Thu, 24 Aug 2023 21:53:53 -0500 Subject: [PATCH 1/4] DEL: Remove old readme.rst doc --- README.rst | 56 ------------------------------------------------------ 1 file changed, 56 deletions(-) delete mode 100644 README.rst diff --git a/README.rst b/README.rst deleted file mode 100644 index 33d462f..0000000 --- a/README.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. image:: https://github.com/openradar/cmweather/actions/workflows/ci.yaml/badge.svg - :target: https://github.com/openradar/cmweather/actions/workflows/ci.yaml - :alt: Continuous Integration Status - -.. image:: https://github.com/openradar/cmweather/actions/workflows/linting.yaml/badge.svg - :target: https://github.com/openradar/cmweather/actions/workflows/linting.yaml - :alt: Code Style Status - -.. image:: https://img.shields.io/codecov/c/github/openradar/cmweather.svg?style=for-the-badge - :target: https://codecov.io/gh/openradar/cmweather - -.. If you want the following badges to be visible, please remove this line, and unindent the lines below - .. image:: https://img.shields.io/readthedocs/cmweather/latest.svg?style=for-the-badge - :target: https://cmweather.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status - - .. image:: https://img.shields.io/pypi/v/cmweather.svg?style=for-the-badge - :target: https://pypi.org/project/cmweather - :alt: Python Package Index - - .. image:: https://img.shields.io/conda/vn/conda-forge/cmweather.svg?style=for-the-badge - :target: https://anaconda.org/conda-forge/cmweather - :alt: Conda Version - - -cmweather -========= - -Development ------------- - -For a development install, do the following in the repository directory: - -.. code-block:: bash - - conda env update -f ci/environment.yml - conda activate cmweather-dev - python -m pip install -e . - -Also, please install `pre-commit` hooks from the root directory of the created project by running:: - - pre-commit install - -These code style pre-commit hooks (black, isort, flake8, ...) will run every time you are about to commit code. - -.. If you want the following badges to be visible, please remove this line, and unindent the lines below - Re-create notebooks with Pangeo Binder - -------------------------------------- - - Try notebooks hosted in this repo on Pangeo Binder. Note that the session is ephemeral. - Your home directory will not persist, so remember to download your notebooks if you - made changes that you need to use at a later time! - - .. image:: https://img.shields.io/static/v1.svg?logo=Jupyter&label=Pangeo+Binder&message=GCE+us-central1&color=blue&style=for-the-badge - :target: https://binder.pangeo.io/v2/gh/openradar/cmweather/master?urlpath=lab - :alt: Binder From b1d3f8bd1aab5bfe115845f39521e3acd5509dcf Mon Sep 17 00:00:00 2001 From: mgrover1 Date: Thu, 24 Aug 2023 22:04:25 -0500 Subject: [PATCH 2/4] FIX: Fix syntax for readme --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8260dea --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# cmweather + +[![CI Status](https://github.com/openradar/cmweather/actions/workflows/ci.yaml/badge.svg)](https://github.com/openradar/cmweather/actions/workflows/ci.yaml) [![code-style](https://github.com/openradar/cmweather/actions/workflows/linting.yaml/badge.svg)](https://github.com/openradar/cmweather/actions/workflows/linting.yaml) [![CodeCov](https://img.shields.io/codecov/c/github/openradar/cmweather.svg?style=for-the-badge)](https://codecov.io/gh/openradar/cmweather)[![Conda Package](https://anaconda.org/conda-forge/cmweather/badges/version.svg)](https://anaconda.org/conda-forge/cmweather) + +## Motivation + +The motivation for this package is to contain weather maps relevant to the weather and climate community. There are **many** colormaps that are unique to the weather/climate community that are not included in core libraries such as [matplotlib](https://matplotlib.org/). This is also meant to be a community collaboration, across multiple domain-specific packages (ex. MetPy, GeoCAT, Py-ART). It is lightweight, easy to install, and we encourage contributions from across the community! + +While not all of the colormaps are color vision deficiency (CVD) friendly, we do include CVD friendly colormaps, and encourage users to use these when possible. + +## Installation + +cmweather can be found on both PyPI and conda-forge, installable using + +```bash +mamba install cmweather +``` + +or + +```bash +pip install cmweather +``` + +### Development Installation + +For a development install, do the following in the repository directory: + +```bash +conda env update -f ci/environment.yml +conda activate cmweather-dev +python -m pip install -e . +``` + +Also, please install `pre-commit` hooks from the root directory of the created project by running: + +``` +pre-commit install +``` From c90ccb5c360b6bb359b2ccf924ebebff8f748c79 Mon Sep 17 00:00:00 2001 From: mgrover1 Date: Thu, 24 Aug 2023 22:06:19 -0500 Subject: [PATCH 3/4] remove old rst --- README.rst | 59 ------------------------------------------------------ 1 file changed, 59 deletions(-) delete mode 100644 README.rst diff --git a/README.rst b/README.rst deleted file mode 100644 index b88121a..0000000 --- a/README.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. image:: https://github.com/openradar/cmweather/actions/workflows/ci.yaml/badge.svg - :target: https://github.com/openradar/cmweather/actions/workflows/ci.yaml - :alt: Continuous Integration Status - -.. image:: https://github.com/openradar/cmweather/actions/workflows/linting.yaml/badge.svg - :target: https://github.com/openradar/cmweather/actions/workflows/linting.yaml - :alt: Code Style Status - -.. image:: https://img.shields.io/codecov/c/github/openradar/cmweather.svg?style=for-the-badge - :target: https://codecov.io/gh/openradar/cmweather - -.. image:: https://anaconda.org/conda-forge/cmweather/badges/version.svg - :target: https://anaconda.org/conda-forge/cmweather - -.. If you want the following badges to be visible, please remove this line, and unindent the lines below - .. image:: https://img.shields.io/readthedocs/cmweather/latest.svg?style=for-the-badge - :target: https://cmweather.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status - - .. image:: https://img.shields.io/pypi/v/cmweather.svg?style=for-the-badge - :target: https://pypi.org/project/cmweather - :alt: Python Package Index - - .. image:: https://img.shields.io/conda/vn/conda-forge/cmweather.svg?style=for-the-badge - :target: https://anaconda.org/conda-forge/cmweather - :alt: Conda Version - - -cmweather -========= - -Development ------------- - -For a development install, do the following in the repository directory: - -.. code-block:: bash - - conda env update -f ci/environment.yml - conda activate cmweather-dev - python -m pip install -e . - -Also, please install `pre-commit` hooks from the root directory of the created project by running:: - - pre-commit install - -These code style pre-commit hooks (black, isort, flake8, ...) will run every time you are about to commit code. - -.. If you want the following badges to be visible, please remove this line, and unindent the lines below - Re-create notebooks with Pangeo Binder - -------------------------------------- - - Try notebooks hosted in this repo on Pangeo Binder. Note that the session is ephemeral. - Your home directory will not persist, so remember to download your notebooks if you - made changes that you need to use at a later time! - - .. image:: https://img.shields.io/static/v1.svg?logo=Jupyter&label=Pangeo+Binder&message=GCE+us-central1&color=blue&style=for-the-badge - :target: https://binder.pangeo.io/v2/gh/openradar/cmweather/master?urlpath=lab - :alt: Binder From 3be567a8b802c971e30332cf28435d7b42e7d2be Mon Sep 17 00:00:00 2001 From: mgrover1 Date: Thu, 24 Aug 2023 22:06:48 -0500 Subject: [PATCH 4/4] DEL: Remove old contrib --- CONTRIBUTING.rst | 151 ----------------------------------------------- 1 file changed, 151 deletions(-) delete mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index a0e5577..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,151 +0,0 @@ -============================================= -Contributing to cmweather -============================================= - -Contributions are highly welcomed and appreciated. Every little help counts, -so do not hesitate! - -The following sections cover some general guidelines -regarding development in cmweather for maintainers and contributors. -Nothing here is set in stone and can't be changed. -Feel free to suggest improvements or changes in the workflow. - - - -.. contents:: Contribution links - :depth: 2 - - - -.. _submitfeedback: - -Feature requests and feedback ------------------------------ - -Do you like cmweather? Share some love on Twitter or in your blog posts! - -We'd also like to hear about your propositions and suggestions. Feel free to -`submit them as issues `_ and: - -* Explain in detail how they should work. -* Keep the scope as narrow as possible. This will make it easier to implement. - - -.. _reportbugs: - -Report bugs ------------ - -Report bugs for cmweather in the `issue tracker `_. - -If you are reporting a bug, please include: - -* Your operating system name and version. -* Any details about your local setup that might be helpful in troubleshooting, - specifically the Python interpreter version, installed libraries, and cmweather - version. -* Detailed steps to reproduce the bug. - -If you can write a demonstration test that currently fails but should pass -(xfail), that is a very useful commit to make as well, even if you cannot -fix the bug itself. - - -.. _fixbugs: - -Fix bugs --------- - -Look through the `GitHub issues for bugs `_. - -Talk to developers to find out how you can fix specific bugs. - - -Write documentation -------------------- - -cmweather could always use more documentation. What exactly is needed? - -* More complementary documentation. Have you perhaps found something unclear? -* Docstrings. There can never be too many of them. -* Blog posts, articles and such -- they're all very appreciated. - -You can also edit documentation files directly in the GitHub web interface, -without using a local copy. This can be convenient for small fixes. - -.. note:: - Build the documentation locally with the following command: - - .. code:: bash - - $ conda env update -f ci/environment.yml - $ cd docs - $ make html - - The built documentation should be available in the ``docs/_build/``. - - - .. _`pull requests`: -.. _pull-requests: - -Preparing Pull Requests ------------------------ - - -#. Fork the - `cmweather GitHub repository `__. It's - fine to use ``cmweather`` as your fork repository name because it will live - under your user. - -#. Clone your fork locally using `git `_ and create a branch:: - - $ git clone git@github.com:YOUR_GITHUB_USERNAME/cmweather.git - $ cd cmweather - # now, to fix a bug or add feature create your own branch off "master": - - $ git checkout -b your-bugfix-feature-branch-name master - - - -#. Install `pre-commit `_ and its hook on the cmweather repo:: - - $ pip install --user pre-commit - $ pre-commit install - - Afterwards ``pre-commit`` will run whenever you commit. - - https://pre-commit.com/ is a framework for managing and maintaining multi-language pre-commit hooks - to ensure code-style and code formatting is consistent. - -#. Install dependencies into a new conda environment:: - - $ conda env update -f ci/environment.yml - - -#. Run all the tests - - Now running tests is as simple as issuing this command:: - - $ conda activate sandbox-devel - $ pytest --junitxml=test-reports/junit.xml --cov=./ --verbose - - - This command will run tests via the "pytest" tool against the latest Python version. - -#. You can now edit your local working copy and run the tests again as necessary. Please follow PEP-8 for naming. - - When committing, ``pre-commit`` will re-format the files if necessary. - -#. Commit and push once your tests pass and you are happy with your change(s):: - - $ git commit -a -m "" - $ git push -u - - -#. Finally, submit a pull request through the GitHub website using this data:: - - head-fork: YOUR_GITHUB_USERNAME/cmweather - compare: your-branch-name - - base-fork: openradar/cmweather - base: master