windspharm - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #go #android #deep-learning #docker #java #awesome #cli #security #mcp #open-source

windspharm

(★ 100)

A Python library for spherical harmonic computations on vector winds.

파일 탐색기

최종 버전 다운로드 (.zip)

- - deploy-docs.yml
  - pypi.yml
  - tests-standard.yml
  - tests.yml
- dependabot.yml
- - headerimage.png
  - logo.png
- - layout.html
  - sidebar_toc.html
- - index.rst
  - windspharm.iris.rst
  - windspharm.standard.rst
  - windspharm.tools.rst
  - windspharm.xarray.rst
- - index.rst
  - testing.rst
- - index.rst
  - iris_examples_index.rst
  - rws_iris.rst
  - rws_standard.rst
  - rws_xarray.rst
  - sfvp_iris.rst
  - sfvp_standard.rst
  - sfvp_xarray.rst
  - standard_examples_index.rst
  - xarray_examples_index.rst
- - index.rst
  - interfaces.rst
  - overview.rst
  - usage.rst
- changelog.rst
- conf.py
- example_code
- index.rst
- Makefile
- - rws_example.py
  - sfvp_example.py
- - rws_example.py
  - sfvp_example.py
- - rws_example.py
  - sfvp_example.py
- - __init__.py
- - __init__.py
  - reference.py
  - test_description.txt
  - test_error_handling.py
  - test_solution.py
  - test_tools.py
  - utils.py
- __init__.py
- _common.py
- iris.py
- standard.py
- tools.py
- xarray.py
.gitignore
.pre-commit-config.yaml
license.txt
MANIFEST.in
pyproject.toml
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ajdawson/windspharm

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd windspharm

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Python

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

python -m pip install windspharm

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

windspharm - spherical harmonic vector wind analysis in Python
==============================================================

[![DOI (paper)](https://img.shields.io/badge/DOI%20%28paper%29-10.5334%2Fjors.129-blue.svg)](https://doi.org/10.5334/jors.129) [![DOI (latest release)](https://zenodo.org/badge/4715033.svg)](https://zenodo.org/records/1401190)

Overview
--------

`windspharm` is a Python package for computing quantities derived from global wind
fields using spherical harmonics, licensed under the MIT license.
windspharm provides a user-friendly interface for vector wind computations on the
sphere (e.g., divergence, streamfunction etc.). It is based on the
[pyspharm](https://github.com/jswhit/pyspharm) module.
windspharm provides a replacement for the windfield package from CDAT.

Requirements
------------

`windspharm` only requires [`numpy`](https://numpy.org) and [`pyspharm`](https://github.com/jswhit/pyspharm) (version 1.0.9 or higher), but for full functionality (meta-data interfaces) one or both of [`iris`](https://scitools-iris.readthedocs.io/) and/or [`xarray`](https://docs.xarray.dev) are required.

Documentation
-------------

Documentation is available [online](https://ajdawson.github.io/windspharm).
The package docstrings are also very complete and can be used as a source of reference when working interactively.

Citation
--------

If you use windspharm in published research, please cite it by referencing the [peer-reviewed paper](https://doi.org/10.5334/jors.129).
You can additionally cite the [Zenodo DOI](https://zenodo.org/badge/latestdoi/20448/ajdawson/windspharm) if you need to cite a particular version (but please also cite the paper, it helps me justify my time working on this and similar projects).

Frequently asked questions
--------------------------

* **Do I need iris/xarray to use windspharm?**
  No. All the computation code uses numpy only. The iris and/or xarray modules are only required for the meta-data preserving interfaces.
* **Is windspharm a drop in replacement for windfield?**
  No. Because windspharm was written from scratch the naming conventions for methods
  are different. Some new methods have been added compared to windfield, and some
  methods from windfield do not exist in windspharm.

Installation
------------

The easiest way to install is via [conda](https://docs.conda.io):

conda install -c conda-forge windspharm

You can also install with pip::

python -m pip install windspharm

> [!CAUTION]
> Make sure you already have pyspharm dependency installed, as it may fail to install if pip tries to do it.