Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "PyData Ecosystem" to "Scientific Python Ecosystem" #3447

Merged
merged 4 commits into from
Sep 23, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Sep 23, 2024

Description of proposed changes

Using "Scientific Python ecosystem" instead of "PyData ecosystem" following the discussion in issue #3442.

Fixes #3442

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Sep 23, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Sep 23, 2024
@seisman
Copy link
Member

seisman commented Sep 23, 2024

Please also update this line:

# wrapper around regular PyData formats. It also allows the data to have labeled

README.md Outdated
@@ -45,8 +45,8 @@ widely used across the Earth, Ocean, and Planetary sciences and beyond.
- Build a Pythonic API for GMT.
- Interface with the GMT C API directly using ctypes (no system calls).
- Support for rich display in the Jupyter notebook.
- Integration with the [PyData ecosystem](https://pydata.org/): `numpy.ndarray` or `pandas.DataFrame` for
data tables, `xarray.DataArray` for grids, and `geopandas.GeoDataFrame` for geographical data.
- Integration with the [Scientific Python ecosystem](https://scientific-python.org/): `numpy.ndarray` or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel it should be "scientific Python ecosystem" following https://scientific-python.org/about/ and https://www.nature.com/articles/s41586-020-2649-2.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I was also wondering which version we want to use, as I found all three "Scientific Python Ecosystem", "Scientific Python ecosystem", and "scientific Python ecosystem". But going with the one used on the official website makes sense.

@yvonnefroehlich yvonnefroehlich self-assigned this Sep 23, 2024
Comment on lines 193 to 194
# ``x`` is initialized as an :class:`xarray.DataArray` object. This object provides a
# wrapper around regular PyData formats. It also allows the data to have labeled
# dimensions while supporting operations that use various pieces of metadata. The
# following code uses :func:`pandas.date_range` to fill the DataArray with data, but
# this is not essential for the creation of a valid DataArray.
# wrapper around regular scientific Python formats. It also allows the data to have
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This object provides a wrapper around regular scientific Python formats.

I'm unsure what "scientific Python formats" means. The official documentation (https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html) says:

DataArray provides a wrapper around numpy ndarrays that uses labeled dimensions and coordinates to support metadata aware operations.

Copy link
Member Author

@yvonnefroehlich yvonnefroehlich Sep 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! Actually I was already a bit confused by "regular PyData formats". So, I just replaced the term. Maybe we should rewrite this sentence to something similar as in the official xarray docs, please see commit 2773524.

@seisman seisman changed the title DOC: Update "PyData" to "Scientific Python" Update "PyData Ecosystem" to "Scientific Python Ecosystem" Sep 23, 2024
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks.good to me. I have updatedthe PR title to reflect the main changes.

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Sep 23, 2024
@seisman seisman merged commit a5dbc13 into main Sep 23, 2024
21 of 22 checks passed
@seisman seisman deleted the update-pde-to-spe branch September 23, 2024 23:39
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use "PyData Ecosystem" or "Scientific Python Ecosystem"?
3 participants