Skip to main content

GeoCAT-comp is computational component of the GeoCAT project and provides

Project description

CI GitHub Workflow Status GitHub Workflow Status Code Coverage Status
Docs Documentation Status
Package Conda PyPI
License License
Citing DOI

GeoCAT-comp is both the whole computational component of the GeoCAT project and a single Github repository as described here. As the computational component of GeoCAT, GeoCAT-comp provides implementations of computational functions for operating on geosciences data. Many of these functions originated in NCL and were translated into Python with the help of GeoCAT-comp; however, developers are welcome to come up with novel computational functions for geosciences data.

Many of the computational functions in GeoCAT are implemented in a pure Python fashion. However, there are some others that are implemented in Fortran but wrapped up in Python. To facilitate contribution, the whole GeoCAT-comp structure is split into two repositories with respect to being pure-Python or Python with compiled codes (i.e. Fortran) implementations. Such implementation layers are handled within GeoCAT-comp and GeoCAT-f2py repositories, respectively (The GeoCAT-f2py repo is documented on its own).

GeoCAT-comp

GeoCAT-comp repo does not explicitly contain or require any compiled code, making it more accessible to the general Python community at large. However, if GeoCAT-f2py is installed, then all functions contained in the "geocat.f2py" package are imported seamlessly into the "geocat.comp" namespace. Thus, GeoCAT-comp repo serves as a user API to access the entire computational toolkit even though the repo itself only contains pure Python code from the contributor’s perspective. Whenever prospective contributors want to add new computational functionality implemented as pure Python, GeoCAT-comp is the repo to do so. Therefore, there is no onus on contributors of pure python code to build/compile/test any compiled code (i.e. Fortran) at GeoCAT-comp level.

Documentation

GeoCAT Homepage

GeoCAT Contributor's Guide

GeoCAT-comp documentation on Read the Docs

Installation and build instructions

Please see our documentation for installation and build instructions.

Xarray interface vs NumPy interface

GeoCAT-comp provides a high-level Xarray interface under the geocat.comp namespace. However, a stripped-down NumPy interface is used under the hood to bridge the gap between NumPy arrays and the compiled language data structures used by GeoCAT-f2py. These functions are accessible under the geocat.comp namespace, but are minimally documented and are intended primarily for internal use.

Citing GeoCAT-comp

If you use this software, please cite it as described at the GeoCAT-comp - Citation page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geocat.comp-2022.10.0.tar.gz (51.8 kB view details)

Uploaded Source

Built Distribution

geocat.comp-2022.10.0-py3-none-any.whl (49.2 kB view details)

Uploaded Python 3

File details

Details for the file geocat.comp-2022.10.0.tar.gz.

File metadata

  • Download URL: geocat.comp-2022.10.0.tar.gz
  • Upload date:
  • Size: 51.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for geocat.comp-2022.10.0.tar.gz
Algorithm Hash digest
SHA256 e6d8e12c3f8dda155d18066341de36c2c42005f087c1e27ab62b9aaa8dbef61d
MD5 8b427f59798449f94b503acfaa82ef56
BLAKE2b-256 4688caca033124d9fd67096378ea6b1436cad4533bc029dbf863f9f9e8d5a0c4

See more details on using hashes here.

Provenance

File details

Details for the file geocat.comp-2022.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for geocat.comp-2022.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 798d90c74b4b4081aa7b8bc85238ab4d3754305ee889e39646a8b5178ea09811
MD5 e7e88d09bc0bc157dfe2d078d8df51dc
BLAKE2b-256 c8feeee1d60f0350b1942295f41cf3b43b737ce066238cce483c416c65c4f5c6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page