Add documentation on creating composites #513

pnuu · 2018-11-22T11:45:35Z

This PR updates the documentatin on compositors and how the composites can be created and further configured in YAML.

Closes Add/update documentation about composites and compositors #511

coveralls · 2018-11-22T12:07:06Z

Coverage increased (+0.3%) to 74.621% when pulling 755d2ef on document-composites into a7b3bc5 on master.

codecov · 2018-11-22T13:59:04Z

Codecov Report

Merging #513 into master will increase coverage by 1.21%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #513      +/-   ##
==========================================
+ Coverage   74.31%   75.53%   +1.21%     
==========================================
  Files         136      137       +1     
  Lines       18188    20948    +2760     
==========================================
+ Hits        13517    15823    +2306     
- Misses       4671     5125     +454

Impacted Files	Coverage Δ
satpy/composites/__init__.py	`48% <ø> (+6.85%)`	⬆️
satpy/writers/ninjotiff.py	`16.66% <0%> (-4.39%)`	⬇️
satpy/readers/scatsat1_l2b.py	`20% <0%> (-3.53%)`	⬇️
satpy/tests/reader_tests/test_utils.py	`69.23% <0%> (-2.94%)`	⬇️
satpy/readers/fci_fdhsi.py	`17.82% <0%> (-2.4%)`	⬇️
satpy/readers/gac_lac_l1.py	`10.14% <0%> (-1.86%)`	⬇️
satpy/readers/li_l2.py	`23.46% <0%> (-0.42%)`	⬇️
satpy/tests/test_plugin.py	`0% <0%> (ø)`	⬆️
satpy/tests/test_utils.py	`100% <0%> (ø)`	⬆️
satpy/readers/amsr2_l1b.py	`100% <0%> (ø)`	⬆️
... and 42 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a7b3bc5...e2cd34e. Read the comment docs.

djhoese · 2018-11-23T18:58:04Z

I really think we should consider using the autodoc functionality and moving this documentation either in to the satpy/composites/__init__.py module or using .. autosummary:: or similarly .. autoclass:: for the composite classes. One difficulty is that the autoclass (and other autodoc sections) aren't meant to be duplicated so we'd have to think about how to do that best. I also noticed that autosummary wasn't giving a useful number of the arguments in the generated docs. Maybe there are options for both that could be useful.

pnuu · 2018-12-03T13:27:38Z

There are couple of compositors that need better explainations (esp. RatioSharpenedRGB and SelfSharpenedRGB), and also few enhancements (histogram, crefl_scaling, cira_stretch and lookup) that lack information. Anyone with anything to contribute, please do, so we could call this PR "ready for now". @djhoese @mraspaud @adybbroe, would you have few moments?

djhoese

It's nice to have this documentation but it just makes me realize how difficult it is to do some of this stuff. Have you tested that the generated HTML properly links to the compositors, etc?

doc/source/composites.rst

…ead.

Support for reduced resolution OLCI data

Add 'crop' and 'save_datasets' to MultiScene

Add reader for FY-3 VIRR (virr_l1b)

…available (e.g: Old versions of the HSD format).

WIP: Allow variations of image filename extensions in 'generic_image' reader

Add demo subpackage to simplify test data download

…in if statements.

Allow selection of Himawari VIS calibration coefficients for HSD data

Rename SatPy to Satpy throughout documentation

Previously, the AHI HSD reader navigated through a data file by using assumed-length headers. However, these headers contain descriptors that give the actual length of the header. This PR uses these descriptors to ensure that we always navigate to the correct position in the file (using file.seek) rather than just assuming that each header is always of a certain size. - [x] Tests added - [x] Tests passed - [x] Passes ``git diff origin/master -- "*py" | flake8 --diff``

Mask out invalid values in the precipitation probability product

doc/source/composites.rst

…nto document-composites

…into document-composites

pnuu · 2019-04-08T16:09:37Z

OK, now the new commits are made to the origin, not in my fork. Ye olden days smiteth back.

pnuu · 2019-04-08T16:18:18Z

Something went pretty much wrong in some point. I'll make a new PR from a new branch in my fork with these changes tomorrow and then close this one.

pnuu added help wanted good first issue documentation component:compositors labels Nov 22, 2018

pnuu self-assigned this Nov 22, 2018

pnuu added the work in progress label Dec 3, 2018

pnuu changed the title ~~[WIP] Add documentation on creating composites~~ Add documentation on creating composites Dec 3, 2018

pnuu requested review from djhoese and mraspaud February 8, 2019 11:50

djhoese approved these changes Feb 8, 2019

View reviewed changes

doc/source/composites.rst Outdated Show resolved Hide resolved

djhoese and others added 16 commits February 9, 2019 11:18

Fix non-serializable map_blocks calls throughout satpy

9b0b66b

Try submitting save_datasets directly to dask distributed

696a1cc

Try pushing save_datasets multiscene jobs from main thread

7f712ce

Pass delayed object to multiscene save_datasets

8080a7e

Remove logic for creating a new dask client when using multiscene

99f33b0

Fix pyresample import of parse_area_file for new version of pyresample

db56100

Fix indentation

b8888d4

Allows both full (EFR) and reduced (ERR) resolution OLCI data to be r…

65de49f

…ead.

Merge pull request #614 from simonrp84/master

297a369

Support for reduced resolution OLCI data

Add tests for multiscene crop and save_datasets

3ae2505

Remove unused crop_area from multiscene tests

be9500d

Remove unused glob import

7a7117a

Update multiscene sphinx page to reflect changes to save_animation

f71873a

Add multiscene save_datasets example

68b8f70

Fix confusing error in abi_l1b reader when file fails to open

2c16c2e

Merge pull request #613 from djhoese/feature-mscn-crop-save-datasets

57c7d21

Add 'crop' and 'save_datasets' to MultiScene

djhoese and others added 13 commits April 5, 2019 08:21

Merge pull request #565 from wroberts4/feature_virr_reader

0d738ba

Add reader for FY-3 VIRR (virr_l1b)

Fix one more test with mocking of gcsfs

ac7cf09

Add a test for the case when no updated calibration coefficients are …

371cfe0

…available (e.g: Old versions of the HSD format).

Fix demo tests on Windows

4cd3f1f

Merge pull request #696 from gerritholl/more-forgiving-tiff-extensions

684b9c1

WIP: Allow variations of image filename extensions in 'generic_image' reader

Merge pull request #686 from djhoese/feature-demo-download

52315e3

Add demo subpackage to simplify test data download

Update docstrings with double colons and remove unneeded parentheses …

1cec3b8

…in if statements.

Merge pull request #695 from simonrp84/Him_GSICS

9132476

Allow selection of Himawari VIS calibration coefficients for HSD data

Rename SatPy to Satpy throughout documentation

95fafd8

Merge pull request #699 from djhoese/doc-satpy-capitals

3e35059

Rename SatPy to Satpy throughout documentation

Mask out invalid values in precip_clouds

97e2474

Add the precip product test to the test suite

e9b628b

gerritholl mentioned this pull request Apr 8, 2019

Improve documentation on creating enhancements #702

Open

Merge pull request #700 from mraspaud/fix-precip

f0d1136

Mask out invalid values in the precipitation probability product

gerritholl reviewed Apr 8, 2019

View reviewed changes

doc/source/composites.rst Show resolved Hide resolved

gerritholl reviewed Apr 8, 2019

View reviewed changes

doc/source/composites.rst Outdated Show resolved Hide resolved

gerritholl reviewed Apr 8, 2019

View reviewed changes

doc/source/composites.rst Outdated Show resolved Hide resolved

gerritholl reviewed Apr 8, 2019

View reviewed changes

doc/source/composites.rst Show resolved Hide resolved

gerritholl mentioned this pull request Apr 8, 2019

Add missing docstring for to_image #703

Merged

5 tasks

pnuu added 5 commits April 8, 2019 18:22

Merge branch 'document-composites' of https://github.com/pnuu/satpy i…

b3dbe6a

…nto document-composites

Add positional argument "name" to DayNightCompositor and CloudCompositor

4824749

Fix Seviri VIS channel names in documentation examples

dbefca1

Add link to enhancements.rst

289448c

Merge branch 'document-composites' of https://github.com/pytroll/satpy …

e2cd34e

…into document-composites

pnuu closed this Apr 9, 2019

pnuu mentioned this pull request Apr 9, 2019

Document composites #705

Merged

1 task

pnuu deleted the document-composites branch February 2, 2022 08:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation on creating composites #513

Add documentation on creating composites #513

pnuu commented Nov 22, 2018 •

edited

coveralls commented Nov 22, 2018 •

edited

codecov bot commented Nov 22, 2018 •

edited

djhoese commented Nov 23, 2018

pnuu commented Dec 3, 2018

djhoese left a comment

pnuu commented Apr 8, 2019

pnuu commented Apr 8, 2019

Add documentation on creating composites #513

Add documentation on creating composites #513

Conversation

pnuu commented Nov 22, 2018 • edited

coveralls commented Nov 22, 2018 • edited

codecov bot commented Nov 22, 2018 • edited

Codecov Report

djhoese commented Nov 23, 2018

pnuu commented Dec 3, 2018

djhoese left a comment

Choose a reason for hiding this comment

pnuu commented Apr 8, 2019

pnuu commented Apr 8, 2019

pnuu commented Nov 22, 2018 •

edited

coveralls commented Nov 22, 2018 •

edited

codecov bot commented Nov 22, 2018 •

edited