Skip to main content
Cognite

GitHub Documentation Status Code style: black codecov PyPI

cdffs

A file system interface (cdffs) to allow users to work with CDF Files using the fsspec supported/compatible python packages (pandas, xarray etc).

fsspec provides an abstract file system interface to work with local/cloud storages and based on the protocol name (example, s3 or abfs) provided in the path, fsspec translates the incoming requests to storage specific implementations and send the responses back to the upstream package to work with the desired data.

Refer fsspec documentation to get the list of all supported/compatible python packages.

Installation

cdffs is available on PyPI. Install using,

pip install cognite-cdffs

Usage

Important steps to follow when working with CDF Files using the fsspec supported python packages.

  1. Import cdffs package
  from cognite import cdffs  # noqa
  1. Follow instructions from Authentication to authenticate.

  2. Read/write the files from/to CDF using fsspec supported packages. Example,

    • Read zarr files using using xarray.
    ds = xarray.open_zarr("cdffs://sample_data/test.zarr")
    
    • Write zarr files using xarray.
    ds.to_zarr("cdffs://sample_data/test.zarr", storage_options={"file_metadata": metadata})
    

Refer cdffs.readthedocs.io for more details.

Vendoring

cdffs uses pydandic.v1 package using vendoring. It was mainly introduced to overcome version conflicts related to the Cognite Notebooks.

Contributing

Want to contribute? Check out CONTRIBUTING.

Metadata

Release files for cognite-cdffs 0.3.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cognite-cdffs 0.3.8
File Size Uploaded
cognite_cdffs-0.3.8.tar.gz 101.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cognite-cdffs 0.3.8
File Interpreter ABI Platform
cognite_cdffs-0.3.8-py3-none-any.whl Python 3 none any Details

Total release size: 214.7 kB

Release files / cognite_cdffs-0.3.8.tar.gz

Download URL cognite_cdffs-0.3.8.tar.gz
Size 101.9 kB
Tags Source
SHA-256 checksum
How to use checksums
57fe8dbdfcbe98a5806cfd8f137c16db739b89358e88c4082d46f36c0faeac2b
BLAKE2b-256 checksum
How to use checksums
0af0de1b1c2018aec9b7e31b55fcc26190dc97fa8033a96641f08519cdfa5c15
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.23

Release files / cognite_cdffs-0.3.8-py3-none-any.whl

Download URL cognite_cdffs-0.3.8-py3-none-any.whl
Size 112.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e67a542bf2e2745e370df1bcee9ae222dea5728324fcabf527e51c237ca81664
BLAKE2b-256 checksum
How to use checksums
de3f31590c58d332a4ab6d705311e2a16217f0ed25510be2d11296ec9cd3712f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.23

Release history Release notifications | RSS feed

This release

0.3.8 This release

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.10

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page