<commit_before>.. default-role:: py:obj

.. toctree::
   :maxdepth: 2
   :hidden:

   userguide/index
   examples/index
   api/index
   changelog
   devguide/index


Introduction
============

`windspharm` is a Python package for performing computations on global wind fields in spherical geometry. It provides a high level interface for computations using spherical harmonics. `windspharm` is capable of computing the following quantities from an input vector wind:

* divergence

* vorticity (relative and absolute)

* streamfunction

* velocity potential

* irrotational and non-divergent components of the wind (Helmholtz decomposition)

* vector gradient of a scalar function

* triangular truncation of a scalar field

* magnitude (wind speed)


Download & Installation
-----------------------

Released versions of `windspharm` can be downloaded from `Github <https://github.com/ajdawson/windspharm/releases>`_.
After downloading the source code archive, unzip it and change into the unzipped archive's directory, then to install it:

.. code-block:: bash

   $ python setup.py install

`windspharm` can also be installed from PyPI using pip:

.. code-block:: bash

   $ pip install windspharm

Releases are also available via conda_, packages are built for both Python 2 and 3 on Linux and OSX:

.. code-block:: bash

   $ conda install -c conda-forge windspharm

You can also check out the source code for the development version from the `github repository <https://github.com/ajdawson/windspharm>`_ to access features which are not yet in the released version.

.. note::

   When installing via pip it may appear that the installation has hung.
   However, it is likely that pip is just trying to install the dependency pyspharm, whose setup process requires the user to accept a license.
   If you think your install has hung, try typing *yes* and pressing enter, the install should continue after a short pause (but know that in doing so you are accepting the terms of the Spherepack license: http://www2.cisl.ucar.edu/resources/legacy/spherepack/license).
<commit_msg>Revise install instructions<commit_after>.. default-role:: py:obj

.. toctree::
   :maxdepth: 2
   :hidden:

   userguide/index
   examples/index
   api/index
   changelog
   devguide/index


Introduction
============

`windspharm` is a Python package for performing computations on global wind fields in spherical geometry. It provides a high level interface for computations using spherical harmonics. `windspharm` is capable of computing the following quantities from an input vector wind:

* divergence

* vorticity (relative and absolute)

* streamfunction

* velocity potential

* irrotational and non-divergent components of the wind (Helmholtz decomposition)

* vector gradient of a scalar function

* triangular truncation of a scalar field

* magnitude (wind speed)


Download & Installation
-----------------------

The easiest way to install is via conda_:

.. code-block:: bash

   $ conda install -c conda-forge windspharm

You can also install from PyPI via pip:

.. code-block:: bash

   $ pip install windspharm

Released versions of `windspharm` can be downloaded from `Github <https://github.com/ajdawson/windspharm/releases>`_.
After downloading the source code archive, unzip it and change into the unzipped archive's directory, then to install it:

.. code-block:: bash

   $ python setup.py install

You can also check out the source code for the development version from the `github repository <https://github.com/ajdawson/windspharm>`_ to access features which are not yet in the released version.

.. note::

   When installing via pip it may appear that the installation has hung.
   However, it is likely that pip is just trying to install the dependency pyspharm, whose setup process requires the user to accept a license.
   If you think your install has hung, try typing *yes* and pressing enter, the install should continue after a short pause (but know that in doing so you are accepting the terms of the Spherepack license: http://www2.cisl.ucar.edu/resources/legacy/spherepack/license).

{'fraction_non_alphanumeric': 0.07722289890377589, 'fraction_numerical': 0.00146163215590743, 'mean_word_length': 3.929171668667467, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7169798', 'n_tokens_mistral': 1127, 'n_tokens_neox': 1046, 'n_words': 514}