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-2023.3.0.tar.gz (46.2 kB view details)

Uploaded Source

Built Distribution

geocat.comp-2023.3.0-py3-none-any.whl (44.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: geocat.comp-2023.3.0.tar.gz
  • Upload date:
  • Size: 46.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for geocat.comp-2023.3.0.tar.gz
Algorithm Hash digest
SHA256 cfe96b1bc6befbefb7d92de640f12874cabb28516640f861fde4fadd1f026162
MD5 30cf13d9736a531c79005b86dbc3228b
BLAKE2b-256 dac7ae4be18df443acef6103a2e40f63f60e87eb51efd2cc44f6db8d88129a5a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for geocat.comp-2023.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 606080461a9d6ca684ecbb683c8981c27732eb0a948c5790bf5a62c7a685e1ed
MD5 079e31f4285173f43a1eccbb6a71c4ef
BLAKE2b-256 a444c41783d24bf882535b258552eadc8a84de6c8efc0eb7db6ad9ea7cbdf0ef

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