11# Files Collections
22
3- [ ![ Linting] ( https://github.com/robin-cls/ fcollections/actions/workflows/pre-commit.yaml/badge.svg )] ( https://github.com/robin-cls /fcollections/actions/workflows/pre-commit.yaml )
4- [ ![ Tests] ( https://github.com/robin-cls/ fcollections/actions/workflows/tests.yaml/badge.svg )] ( https://github.com/robin-cls /fcollections/actions/workflows/tests.yaml )
5- [ ![ Documentation] ( https://github.com/robin-cls/ fcollections/actions/workflows/doc.yaml/badge.svg )] ( https://github.com/robin-cls /fcollections/actions/workflows/doc.yaml )
6- ![ License] ( https://img.shields.io/github/license/robin-cls /fcollections )
3+ [ ![ Linting] ( https://cnes. github.io/ fcollections/actions/workflows/pre-commit.yaml/badge.svg )] ( https://cnes. github.io /fcollections/actions/workflows/pre-commit.yaml )
4+ [ ![ Tests] ( https://cnes. github.io/ fcollections/actions/workflows/tests.yaml/badge.svg )] ( https://cnes. github.io /fcollections/actions/workflows/tests.yaml )
5+ [ ![ Documentation] ( https://cnes. github.io/ fcollections/actions/workflows/doc.yaml/badge.svg )] ( https://cnes. github.io /fcollections/actions/workflows/doc.yaml )
6+ ![ License] ( https://img.shields.io/github/license/cnes /fcollections )
77
88
99Select and read a collection of files
@@ -15,28 +15,49 @@ Select and read a collection of files
1515- Easy building of an implementation for a new product
1616
1717
18- ## Quick start
18+ ## Installation
1919
2020``` bash
21- conda install files_collections
21+ conda install files_collections -c conda-forge
2222```
2323
24+ ## Use
25+
2426``` python
2527from fcollections.implementations import NetcdfFilesDatabaseSwotLRL3
26- fc = NetcdfFilesDatabaseSwotLRL3(" data" )
27- fc.query(cycle_number = 1 , pass_number = 1 )
28+
29+ fc = NetcdfFilesDatabaseSwotLRL3(" data_dir" )
30+ ds = fc.query(subset = ' Basic' , cycle_number = 1 , pass_number = 1 )
31+
32+ print (ds.sizes)
33+ ```
34+
35+ Output:
36+
37+ ``` text
38+ Frozen({'num_lines': 9860, 'num_pixels': 69})
39+ ```
40+
41+ ``` python
42+ print (list (ds.data_vars))
43+ ```
44+
45+ Output:
46+
47+ ``` text
48+ ['mdt', 'ssha_filtered', 'ssha_unfiltered', 'cycle_number', 'pass_number']
2849```
2950
3051## Documentation
3152
3253📘 ** Full documentation:**
33- https://robin-cls .github.io/fcollections/index.html#
54+ https://cnes .github.io/fcollections/index.html
3455
3556Key pages:
36- - [ Getting started] ( https://robin-cls .github.io/fcollections/getting_started.html )
37- - [ Installation] ( https://robin-cls .github.io/fcollections/install.html )
38- - [ Catalog] ( https://robin-cls .github.io/fcollections/implementations/catalog.html )
39- - [ Changelog] ( https://robin-cls .github.io/fcollections/changelog.html )
57+ - [ Getting started] ( https://cnes .github.io/fcollections/getting_started.html )
58+ - [ Installation] ( https://cnes .github.io/fcollections/install.html )
59+ - [ Catalog] ( https://cnes .github.io/fcollections/implementations/catalog.html )
60+ - [ Changelog] ( https://cnes .github.io/fcollections/changelog.html )
4061
4162## Project status
4263
0 commit comments