list of accepted meta data for custom Maps #1940

abit2 · 2016-11-07T21:08:07Z

#1832
updated the docstrings of the properties of what meta kwargs they use

abit2 · 2016-11-16T17:43:49Z

Ping @Cadair
Does it require more documentation?

Cadair

As well as the inline comments the keyword and default values should be in double backticks i.e.

``detector``

I think we should also think of something more descriptive than 'meta keyword' I am open to suggestions but maybe 'obtained from meta keyword' as it's more than just a lookup in some cases.

Finally, I think this should be in the Notes section of the docstring so:

"""
Detector name

Notes
-----
Obtained from meta keyword: ``detector``, default: ``""``.

Cadair · 2017-01-06T11:22:43Z

sunpy/map/mapbase.py

@@ -601,6 +655,7 @@ def rotation_matrix(self):
        """
        Matrix describing the rotation required to align solar North with
        the top of the image.
+        Meta keyword : PC1_1, PC1_2, PC2_1, PC2_2, CD1_1, CD1_2, CD2_1, CD2_2


some mention of of PC or CD would be nice here.

Cadair · 2017-01-06T11:23:25Z

sunpy/map/mapbase.py

-        """Heliographic longitude"""
+        """
+        Heliographic longitude
+        Meta keyword : hgln_obs


for cases like this where a a not-None default is set it would be nice to have that in the docstring as well.

something like meta keyword: crval1 (default 0 deg), crval2 (default: 0 deg)

Cadair · 2017-01-06T11:25:24Z

sunpy/map/mapbase.py

-        """Heliographic latitude"""
+        """
+        Heliographic latitude
+        Meta keyword : hglt_obs


this is not very clear, something like meta keyword: hglt_obs / crlt_obs / solar_b0 [in order of preference]

Cadair · 2017-01-06T11:30:07Z

Also, all the files in sunpy/map/sources should be check to see if they modify any of these properties because then the docstrings should be changed there as well.

abit2 · 2017-01-07T05:46:55Z

didn't understand changing sunpy/map/sources part
can you please explain.

abit2 · 2017-01-10T13:50:50Z

@Cadair As far as I can tell, it doesnot change anywhere else in sunpy/map/sources

Cadair · 2017-01-10T13:59:56Z

@abit2 I mean methods like this: https://github.com/sunpy/sunpy/blob/master/sunpy/map/sources/sdo.py#L51 also need documenting in the same fashion.

Cadair · 2017-01-12T12:49:22Z

Sweet Jesus that's a lot of pep8

OrkoHunter · 2017-01-12T13:25:37Z

@abit2 I think the PR needs a rebase to ignore all the trivial E501s. :)

Cadair · 2017-01-12T13:28:55Z

@OrkoHunter I thought it pulled the config from the main repo not the PR? Has that changed since the out-of-date version I was playing with?

OrkoHunter · 2017-01-12T13:32:39Z

@Cadair Earlier it used to pull the config from the main repo's branch. But after testing on different projects, similar to Travis CI, pulling the (updated) config from the PR made more sense.

Now I think, there should be a change. If the config is not there in the PR's branch, it should check the main repo. I'd love to hear your suggestions.

pep8speaks · 2017-01-12T19:20:03Z

Hello @abit2! Thanks for updating the PR.

In the file sunpy/map/mapbase.py, following are the PEP8 issues :

Line 1372:101: E501 line too long (138 > 100 characters)
Line 1415:101: E501 line too long (101 > 100 characters)
Line 1417:101: E501 line too long (101 > 100 characters)
Line 1583:101: E501 line too long (110 > 100 characters)

In the file sunpy/map/sources/hinode.py, following are the PEP8 issues :

Line 8:1: E402 module level import not at top of file
Line 9:1: E402 module level import not at top of file
Line 10:1: E402 module level import not at top of file
Line 12:1: E402 module level import not at top of file
Line 13:1: E402 module level import not at top of file
Line 45:101: E501 line too long (154 > 100 characters)
Line 111:101: E501 line too long (112 > 100 characters)

In the file sunpy/map/sources/iris.py, following are the PEP8 issues :

Line 39:101: E501 line too long (110 > 100 characters)

In the file sunpy/map/sources/proba2.py, following are the PEP8 issues :

Line 8:1: E402 module level import not at top of file
Line 9:1: E402 module level import not at top of file
Line 29:101: E501 line too long (121 > 100 characters)

In the file sunpy/map/sources/rhessi.py, following are the PEP8 issues :

Line 8:1: E402 module level import not at top of file
Line 9:1: E402 module level import not at top of file
Line 11:1: E402 module level import not at top of file
Line 47:101: E501 line too long (102 > 100 characters)

In the file sunpy/map/sources/sdo.py, following are the PEP8 issues :

Line 8:1: E402 module level import not at top of file
Line 9:1: E402 module level import not at top of file
Line 10:1: E402 module level import not at top of file
Line 12:1: E402 module level import not at top of file
Line 13:1: E402 module level import not at top of file
Line 36:101: E501 line too long (119 > 100 characters)
Line 39:101: E501 line too long (144 > 100 characters)

In the file sunpy/map/sources/soho.py, following are the PEP8 issues :

Line 8:1: E402 module level import not at top of file
Line 9:1: E402 module level import not at top of file
Line 11:1: E402 module level import not at top of file
Line 12:1: E402 module level import not at top of file
Line 13:1: E402 module level import not at top of file
Line 15:1: E402 module level import not at top of file
Line 16:1: E402 module level import not at top of file
Line 17:1: E402 module level import not at top of file
Line 18:1: E402 module level import not at top of file
Line 112:101: E501 line too long (101 > 100 characters)
Line 179:101: E501 line too long (105 > 100 characters)

In the file sunpy/map/sources/stereo.py, following are the PEP8 issues :

Line 8:1: E402 module level import not at top of file
Line 10:1: E402 module level import not at top of file
Line 11:1: E402 module level import not at top of file
Line 13:1: E402 module level import not at top of file
Line 14:1: E402 module level import not at top of file

In the file sunpy/map/sources/trace.py, following are the PEP8 issues :

Line 8:1: E402 module level import not at top of file
Line 9:1: E402 module level import not at top of file
Line 11:1: E402 module level import not at top of file

In the file sunpy/map/sources/yohkoh.py, following are the PEP8 issues :

Line 8:1: E402 module level import not at top of file
Line 10:1: E402 module level import not at top of file
Line 11:1: E402 module level import not at top of file
Line 13:1: E402 module level import not at top of file
Line 14:1: E402 module level import not at top of file
Line 15:1: E402 module level import not at top of file
Line 41:101: E501 line too long (120 > 100 characters)

Cadair

Thanks for all your work on this @abit2 it's looking really good!
Just a few sphinx formatting changes and stuff.

Cadair · 2017-01-12T19:35:08Z

sunpy/map/mapbase.py

+
+        * First available:
+         1. ``ctype1``
+         2. ``HPLN-TAN``


These are defaults not keys

Cadair · 2017-01-12T19:38:08Z

sunpy/map/mapbase.py

-                        else with ``CD1_1``, ``CD1_2``, ``CD2_1``, ``CD2_2``.
+         .. rubric:: Metadata keywords:
+
+        * ``PC1_1``


These are generally written as PCi_j and CDi_j also these are an either or kinda thing, i.e.

* First Available 1. `PCi_j` 2. `CDi_j`

Cadair · 2017-01-12T19:39:26Z

sunpy/map/sources/soho.py

        Returns the solar radius as measured by EIT in arcseconds.
+        .. rubric:: Metadata keyword:
+
+        * ``solar_r``


This is an actual operation on two keywords so we should probably write it as solar_r * cdelt1 to make it clear that's what it is.

Cadair · 2017-01-12T19:40:06Z

sunpy/map/mapbase.py

-           dim=u.Quantity(self.dimensions),
-           scale=u.Quantity(self.scale),
-           tmf=TIME_FORMAT) + self.data.__repr__())
+                obs=self.observatory, inst=self.instrument, det=self.detector,


This change seems to mis-align these kwargs?

Cadair · 2017-01-12T19:40:25Z

sunpy/map/mapbase.py

+        Image observation time
+        .. rubric:: Metadata keyword:
+
+        * ``date-obs`` Default: ``now``


Default 'now' to indicate it is a string.

Cadair · 2017-01-12T19:41:19Z

sunpy/map/mapbase.py

+        wavelength of the observation
+        .. rubric:: Metadata keyword:
+
+        * ``wavelnth`` Default: 0


Cadair · 2017-01-12T19:41:49Z

sunpy/map/mapbase.py

+        Radius of the sun in meters
+        .. rubric:: Metadata keyword:
+
+        * ``rsun_ref`` Default: constants.radius


this can be a full object link

`sunpy.constants.radius`

Cadair · 2017-01-12T19:42:08Z

sunpy/map/mapbase.py

+         1. ``rsun_obs``
+         2. ``solar_r``
+         3. ``radius``
+         4. Default: None


single backticks around None

Cadair · 2017-01-12T19:42:25Z

sunpy/map/mapbase.py

+        Carrington longitude (crln_obs)
+        .. rubric:: Metadata keyword:
+
+        * ``crln_obs`` Default: None


Cadair · 2017-01-12T19:43:21Z

sunpy/map/mapbase.py

@@ -605,6 +721,16 @@ def rotation_matrix(self):
        """
        Matrix describing the rotation required to align solar North with
        the top of the image.
+         .. rubric:: Metadata keywords:
+
+        * ``PC1_1``


These are an either or, and also normally written as PCi_j and CDi_j to cover all four. i.e it should be a first available with two entries.

Cadair · 2017-01-12T19:45:53Z

@pep8speaks Keep Quiet

stale · 2017-06-28T09:37:37Z

This pull request has been automatically marked as stale because it has not had any activity for the past five months. It will be closed if no further activity occurs. If the ideas in this pull request are still worth implementing, please make sure you open an issue to keep track of that idea!

stale · 2017-07-28T14:06:37Z

This pull request has been automatically closed since there was no activity for a month since it was marked as stale. If the ideas in this pull request are still worth implementing, please make sure you open an issue to keep track of that idea!

dpshelio added pending review labels Nov 7, 2016

Cadair removed size/M labels Nov 9, 2016

Cadair requested changes Jan 6, 2017

View reviewed changes

Cadair added Documentation Affects the documentation map Affects the map submodule labels Jan 6, 2017

abit2 force-pushed the list_meta branch from 96acafc to fbb616e Compare January 12, 2017 13:37

Cadair requested changes Jan 12, 2017

View reviewed changes

abit2 added 7 commits January 27, 2017 12:00

list of accepted meta data for custom Maps

ce48abe

added double tick in meta keyword and default values

671db60

added meta keywords in docstring sunpy/map/sources

5a69cbe

pep8 corrections

988366d

changed the format of metadata in docstring

91fc4f8

changes to and similar ones

6d15664

indentation errors

494ed66

abit2 force-pushed the list_meta branch from 451b6fe to 494ed66 Compare January 27, 2017 06:35

conflict error

2fb6bfb

Cadair self-assigned this Jan 28, 2017

dpshelio added this to Review in Docathon - 2017 Mar 6, 2017

stale bot added the Stale The bot will close this PR after 6 months label Jun 28, 2017

stale bot closed this Jul 28, 2017

nabobalis added the Needs Adoption PRs that were abandoned but should be picked up again and merged in label Mar 27, 2018

nabobalis removed the Stale The bot will close this PR after 6 months label Nov 14, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

list of accepted meta data for custom Maps #1940

list of accepted meta data for custom Maps #1940

abit2 commented Nov 7, 2016

abit2 commented Nov 16, 2016

Cadair left a comment

Cadair Jan 6, 2017

Cadair Jan 6, 2017

Cadair Jan 6, 2017

Cadair Jan 6, 2017

Cadair commented Jan 6, 2017

abit2 commented Jan 7, 2017

abit2 commented Jan 10, 2017

Cadair commented Jan 10, 2017

Cadair commented Jan 12, 2017

OrkoHunter commented Jan 12, 2017

Cadair commented Jan 12, 2017

OrkoHunter commented Jan 12, 2017 •

edited

pep8speaks commented Jan 12, 2017

Cadair left a comment

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair Jan 12, 2017

Cadair commented Jan 12, 2017

stale bot commented Jun 28, 2017

stale bot commented Jul 28, 2017

list of accepted meta data for custom Maps #1940

list of accepted meta data for custom Maps #1940

Conversation

abit2 commented Nov 7, 2016

abit2 commented Nov 16, 2016

Cadair left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cadair commented Jan 6, 2017

abit2 commented Jan 7, 2017

abit2 commented Jan 10, 2017

Cadair commented Jan 10, 2017

Cadair commented Jan 12, 2017

OrkoHunter commented Jan 12, 2017

Cadair commented Jan 12, 2017

OrkoHunter commented Jan 12, 2017 • edited

pep8speaks commented Jan 12, 2017

Cadair left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cadair commented Jan 12, 2017

stale bot commented Jun 28, 2017

stale bot commented Jul 28, 2017

OrkoHunter commented Jan 12, 2017 •

edited