Cosmo read/write ECSV by nstarman · Pull Request #12321 · astropy/astropy

nstarman · 2021-10-28T17:30:25Z

Description

A Cosmology can be read from / written to an ECSV file. This keeps all units and metadata and will work when Cosmology is enhanced to be able to be array-valued.

~~Requires #12213 . Will be rebased when that it is merged. Test failing because there is more than 1 changelog fragment.~~
Merged.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

Do the proposed changes actually accomplish desired goals?
Do the proposed changes follow the Astropy coding guidelines?
Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see "When to rebase and squash commits".
Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the Extra CI label.
Is a change log needed? If yes, did the change log check pass? If no, add the no-changelog-entry-needed label. If this is a manual backport, use the skip-changelog-checks label unless special changelog handling is necessary.
Is a milestone set? Milestone must be set but astropy-bot check might be missing; do not let the green checkmark fool you.
At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate backport-X.Y.x label(s) before merge.

pep8speaks · 2021-10-28T17:30:36Z

Hello @nstarman 👋! It looks like you've made some changes in your pull request, so I've checked the code again for style.

There are no PEP8 style issues with this pull request - thanks! 🎉

Comment last updated at 2021-10-30 16:38:46 UTC

nstarman · 2021-10-29T18:20:12Z

@nstarman @taldcroft
If the mypackage move is too large to review, I can split it off of this PR.

@nstarman

Signed-off-by: Nathaniel Starkman (@nstarman) <[email protected]>

@nstarman

Signed-off-by: Nathaniel Starkman (@nstarman) <[email protected]>

taldcroft

Just a few docs comments for now, will try to get to the rest soon.

taldcroft · 2021-10-30T10:58:05Z

 registered. Details are discussed in an addition to the docs.

-Currently no file formats are registered, but the syntax is as follows:
+Currently the only registered read/write format is "ascii.ecsv", like for Table.


No need to sound apologetic, the one format is great and this can be where we try to define the new standard. 😄

Suggested change

Currently the only registered read/write format is "ascii.ecsv", like for Table.

For writing the representation of a ``Cosmology`` to a file, the ECSV [link to APE-6] table format

is available. Astropy is encouraging the use of this format as a standard interoperable

way of storing and communicating cosmology parameters.

Thanks!
Implemented.

taldcroft · 2021-10-30T10:58:45Z

    >>>
-    >>> from astropy.cosmology import Cosmology
-    >>> cosmo = Cosmology.read('<file name>.<format>')
+    >>> cosmo = Cosmology.read('<file name>.ecsv')


Suggested change

>>> cosmo = Cosmology.read('<file name>.ecsv')

>>> cosmo = Cosmology.read('plank18.ecsv')

I didn't think whatsnew was skipped in tests. This makes examples much better.

taldcroft · 2021-10-30T11:08:41Z

+    >>> cosmo = Cosmology.read('<file name>.ecsv')
    >>> cosmo == Planck18
    True



I think the examples below are a bit long for the What's New. The idea is not to comprehensively show the capabilities but just highlight things enough for interested people to click through to the docs link. I think each What's New entry should fit comfortably on one laptop screen (and maybe half the people are reading on mobile?). So maybe just:

Transformations between ``Cosmology`` and `dict`, ``QTable``, and``Model`` are pre-registered, enabling for example:: >>> from astropy.cosmology import Cosmology, Planck18 >>> cm = Planck18.to_format("mapping") >>> cm {'cosmology': <class 'astropy.cosmology.flrw.FlatLambdaCDM'>, 'name': 'Planck18', 'H0': <Quantity 67.66 km / (Mpc s)>, 'Om0': 0.30966, ... For details see :ref:`whatever`.

SGTM. I would like to show Table and Model. I think those are the compelling examples.

@nstarman

Co-authored-by: Tom Aldcroft <[email protected]> Signed-off-by: Nathaniel Starkman (@nstarman) <[email protected]>

taldcroft

Looks good!

nstarman · 2021-10-30T19:56:15Z

Thanks @taldcroft for pushing to get this in for v5.0!

nstarman added this to the v5.0 milestone Oct 28, 2021

nstarman requested a review from taldcroft October 28, 2021 17:30

github-actions Bot added cosmology Docs table testing labels Oct 28, 2021

nstarman force-pushed the cosmo_readwrite_ecsv branch from 16ada4e to 89c75f5 Compare October 28, 2021 17:31

nstarman added the whatsnew-needed label Oct 28, 2021

nstarman force-pushed the cosmo_readwrite_ecsv branch 3 times, most recently from e6b160c to f3c6299 Compare October 28, 2021 18:14

nstarman mentioned this pull request Oct 28, 2021

cosmo: to/from table #12213

Merged

9 tasks done

nstarman requested a review from mhvk October 29, 2021 00:05

nstarman force-pushed the cosmo_readwrite_ecsv branch 4 times, most recently from 464c4a0 to c843604 Compare October 29, 2021 13:24

nstarman force-pushed the cosmo_readwrite_ecsv branch 2 times, most recently from 5788a76 to cdcdf5d Compare October 29, 2021 23:37

Register ECSV into Cosmology read/write

7aa6e7b

Signed-off-by: Nathaniel Starkman (@nstarman) <[email protected]>

nstarman force-pushed the cosmo_readwrite_ecsv branch from cdcdf5d to 4854646 Compare October 30, 2021 01:51

move example package to tests

85dc20d

Signed-off-by: Nathaniel Starkman (@nstarman) <[email protected]>

nstarman force-pushed the cosmo_readwrite_ecsv branch from 4854646 to 85dc20d Compare October 30, 2021 01:55

taldcroft reviewed Oct 30, 2021

View reviewed changes

nstarman force-pushed the cosmo_readwrite_ecsv branch 2 times, most recently from 023ab91 to 9a52d7a Compare October 30, 2021 16:37

pare down the whatsnew

2a4e468

Co-authored-by: Tom Aldcroft <[email protected]> Signed-off-by: Nathaniel Starkman (@nstarman) <[email protected]>

nstarman force-pushed the cosmo_readwrite_ecsv branch from 9a52d7a to 2a4e468 Compare October 30, 2021 16:38

nstarman requested a review from taldcroft October 30, 2021 16:39

taldcroft approved these changes Oct 30, 2021

View reviewed changes

nstarman merged commit 12d5892 into astropy:main Oct 30, 2021

nstarman deleted the cosmo_readwrite_ecsv branch October 30, 2021 19:55

Navigation Menu

Repository navigation

Cosmo read/write ECSV - #12321

Cosmo read/write ECSV#12321
nstarman merged 3 commits into
astropy:mainfrom
nstarman:cosmo_readwrite_ecsv

nstarman commented Oct 28, 2021 •

edited

Loading

Uh oh!

pep8speaks commented Oct 28, 2021 •

edited

Loading

Uh oh!

nstarman commented Oct 29, 2021

Uh oh!

taldcroft left a comment

Uh oh!

Uh oh!

taldcroft Oct 30, 2021

Uh oh!

nstarman Oct 30, 2021

Uh oh!

Uh oh!

taldcroft Oct 30, 2021

Uh oh!

nstarman Oct 30, 2021

Uh oh!

taldcroft Oct 30, 2021

Uh oh!

nstarman Oct 30, 2021

Uh oh!

taldcroft left a comment

Uh oh!

nstarman commented Oct 30, 2021

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-Currently the only registered read/write format is "ascii.ecsv", like for Table.
+For writing the representation of a ``Cosmology`` to a file, the ECSV [link to APE-6] table format
+is available. Astropy is encouraging the use of this format as a standard interoperable
+way of storing and communicating cosmology parameters.

	>>> cosmo = Cosmology.read('<file name>.ecsv')
	>>> cosmo = Cosmology.read('plank18.ecsv')

Conversation

nstarman commented Oct 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist for package maintainer(s)

Uh oh!

pep8speaks commented Oct 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment last updated at 2021-10-30 16:38:46 UTC

Uh oh!

nstarman commented Oct 29, 2021

Uh oh!

taldcroft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

taldcroft Oct 30, 2021

Choose a reason for hiding this comment

Uh oh!

nstarman Oct 30, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

taldcroft Oct 30, 2021

Choose a reason for hiding this comment

Uh oh!

nstarman Oct 30, 2021

Choose a reason for hiding this comment

Uh oh!

taldcroft Oct 30, 2021

Choose a reason for hiding this comment

Uh oh!

nstarman Oct 30, 2021

Choose a reason for hiding this comment

Uh oh!

taldcroft left a comment

Choose a reason for hiding this comment

Uh oh!

nstarman commented Oct 30, 2021

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nstarman commented Oct 28, 2021 •

edited

Loading

pep8speaks commented Oct 28, 2021 •

edited

Loading