Merge pull request #241 from Ouranosinc/add_conda-forge

Add conda-forge

.github/workflows/main.yml

@@ -29,13 +29,13 @@ jobs:
           python-version: "3.9"
       - name: Install tox
         run: |
-          pip install tox~=3.0
+          pip install tox
       - name: Run linting suite
         run: |
           tox -e black
 
   testing:
-    name: Smoke Test with Python${{ matrix.python-version }}
+    name: Test with Python${{ matrix.python-version }}
     needs: black
     runs-on: ubuntu-latest
     strategy:

HISTORY.rst

@@ -9,6 +9,7 @@ Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`), Pascal
 Announcements
 ^^^^^^^^^^^^^
 * Dropped support for Python 3.8, added support for 3.11. (:pull:`199`, :pull:`222`).
+* `xscen` is now available on `conda-forge <https://anaconda.org/conda-forge/xscen>`_, and can be installed with ``conda install -c conda-forge xscen``. (:pull:`241`)
 
 New features and enhancements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

MANIFEST.in

@@ -13,6 +13,7 @@ recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 recursive-exclude docs notebooks *.rst conf.py Makefile make.bat *.jpg *.png *.gif *.ipynb *.csv *.json *.yml *.md
 recursive-exclude docs notebooks samples *.csv *.json
+recursive-exclude conda *.yml
 recursive-exclude templates *.csv *.json *.py *.yml
 
 exclude .cruft.json

README.rst

@@ -2,7 +2,7 @@
 xscen |logo|
 ============
 
-|pypi| |status| |build| |coverage| |docs| |black| |pre-commit| |versions|
+|pypi| |conda| |status| |build| |coverage| |docs| |black| |pre-commit| |versions|
 
 A climate change scenario-building analysis framework, built with Intake-esm catalogs and xarray-based packages such as xclim and xESMF.
 
@@ -11,11 +11,11 @@ For documentation concerning `xscen`, see: https://xscen.readthedocs.io/en/lates
 Features
 --------
 * Supports workflows with YAML configuration files for better transparency, reproducibility, and long-term backups.
-* Intake_esm-based catalog to find and manage climate data.
+* `Intake-esm`_-based catalog to find and manage climate data.
 * Climate dataset extraction, subsetting, and temporal aggregation.
-* Calculate missing variables through Intake-esm's DerivedVariableRegistry.
-* Regridding with xESMF.
-* Bias adjustment with xclim.
+* Calculate missing variables through intake-esm's `DerivedVariableRegistry`_.
+* Regridding powered by `xESMF`_.
+* Bias adjustment tools provided by `xclim`_.
 
 Installation
 ------------
@@ -29,6 +29,10 @@ This package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pyp
 .. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
 .. _Ouranosinc/cookiecutter-pypackage: https://github.com/Ouranosinc/cookiecutter-pypackage
 .. _installation docs: https://xscen.readthedocs.io/en/latest/installation.html
+.. _Intake-esm: https://intake-esm.readthedocs.io/
+.. _DerivedVariableRegistry: https://intake-esm.readthedocs.io/en/latest/how-to/define-and-use-derived-variable-registry.html
+.. _xclim: https://xclim.readthedocs.io/
+.. _xESMF: https://xesmf.readthedocs.io/
 
 .. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xscen/main/docs/_static/_images/xscen-logo-small.png
         :target: https://github.com/Ouranosinc/xscen
@@ -46,6 +50,10 @@ This package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pyp
         :target: https://pypi.python.org/pypi/xscen
         :alt: Python Package Index Build
 
+.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/xscen.svg
+        :target: https://anaconda.org/conda-forge/xscen
+        :alt: Conda Build
+
 .. |docs| image:: https://readthedocs.org/projects/xscen/badge/?version=latest
         :target: https://xscen.readthedocs.io/en/latest/?badge=latest
         :alt: Documentation Status

docs/installation.rst

@@ -5,14 +5,13 @@ Installation
 Official Sources
 ----------------
 
-Because of some packages being absent from PyPI (such as `xESMF`), we strongly recommend installing
-`xscen` in an Anaconda environment.
+Because of some packages being absent from PyPI (such as `xESMF`), we strongly recommend installing `xscen` in an Anaconda environment.
 
-`xscen` can be installed directly from Anaconda.org:
+`xscen` can be installed directly from conda-forge:
 
 .. code-block:: console
 
-    $ conda install -c ouranosinc xscen
+    $ conda install -c conda-forge xscen
 
 .. note::
 
@@ -24,8 +23,8 @@ If for some reason you wish to install the `PyPI` version of `xscen` into an exi
 
     $ pip install xscen
 
-Development Installation (conda + pip)
---------------------------------------
+Development Installation (Anaconda + pip)
+-----------------------------------------
 
 For development purposes, we provide the means for generating a conda environment with the latest dependencies in an `environment.yml` file at the top-level of the `Github repo`_.