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

rebrand IRIS -> EarthScope #3448

Merged
merged 1 commit into from
May 17, 2024
Merged

rebrand IRIS -> EarthScope #3448

merged 1 commit into from
May 17, 2024

Conversation

megies
Copy link
Member

@megies megies commented May 16, 2024

What does this PR do?

Rename IRIS -> EarthScope, this is mostly just docs/docstrings, leave "obspy.clients.iris" module naming as is.

Why was it initiated? Any relevant Issues?

Fixes #3336

PR Checklist

  • Correct base branch selected? master for new features, maintenance_... for bug fixes
  • This PR is not directly related to an existing issue (which has no PR yet).
  • While the PR is still work-in-progress, the no_ci label can be added to skip CI builds
  • If the PR is making changes to documentation, docs pages can be built automatically.
    Just add the build_docs tag to this PR.
    Docs will be served at docs.obspy.org/pr/{branch_name} (do not use master branch).
    Please post a link to the relevant piece of documentation.
  • If all tests including network modules (e.g. clients.fdsn) should be tested for the PR,
    just add the test_network tag to this PR.
  • All tests still pass.
  • Any new features or fixed regressions are covered via new tests.
  • Any new or changed features are fully documented.
  • Significant changes have been added to CHANGELOG.txt .
  • First time contributors have added your name to CONTRIBUTORS.txt .
  • If the changes affect any plotting functions you have checked that the plots
    from all the CI builds look correct. Add the "upload_plots" tag so that plotting
    outputs are attached as artifacts.
  • New modules, add the module to CODEOWNERS with your github handle
  • Add the yellow ready for review label when you are ready for the PR to be reviewed.

this is mostly just docs/docstrings, leave "obspy.clients.iris" module
naming as is
@megies megies added docs issues that only affect the content of documentation pages, docstrings etc build_docs Docs will be automatically built and deployed in github actions on pushes to the PR labels May 16, 2024
@megies megies added this to the 1.5.0 milestone May 16, 2024
@megies
Copy link
Member Author

megies commented May 16, 2024

@chad-earthscope I went through our codebase and tried to most appropriately replace "IRIS" wording, even though some of the web services still go under the "IRISWS" label and also I'm not sure if/where it might be more appropriate to use "SAGE" instead of "EarthScope".

Feel free to comment and check out the docs build for this PR when CI is done (https://docs.obspy.org/pr/).

I would really rather keep the module structure/Pathon file naming of obspy.clients.iris as is, it's just an insane amount of work to do that and make sure deprecation rerouting works and things can easily break and a lot of peoples' codes will break eventually, since not a lot of people really act on DeprecationWarnings 🤣
Also, these services are still kinda labeled as "IRISWS" anyway on the respective websites.

@megies megies added the ready for review PRs that are ready to be reviewed to get marked ready to merge label May 16, 2024
@jkmacc-LANL
Copy link
Contributor

jkmacc-LANL commented May 16, 2024

ObsPy is many students' first introduction to community data at IRIS-now-EarthScope; I think that from obspy.clients.earthscope import Client means a lot more than just a Python import. Is it possible to at least alias a stub obspy.clients.earthscope module to obspy.clients.iris so that the import statement works? I realize that it may be more complicated than I think, but if it's not, it seems worth doing.

@d-chambers
Copy link
Member

I realize that it may be more complicated than I think, but if it's not, it seems worth doing.

We could just do a wildcard import at the top of a newly created earthscope module no?

from obspy.clients.iris import *

In that case the modules should behave identically.

@megies
Copy link
Member Author

megies commented May 16, 2024

I think that from obspy.clients.earthscope import Client means a lot more than just a Python import

These are "only" the IRIS-custom web services, which actually are still branded "IRISWS" upstream.
In the fdsn clients I replaced the default client with a new "EARTHSCOPE" short URL.

We could just do a wildcard import at the top of a newly created earthscope module no?

We'd have to mirror the internal module structure (which admittedly is quite simple). I really doubt the gain from that though, considering the confusion it will create simultaneously.

@megies
Copy link
Member Author

megies commented May 17, 2024

I'll merge this for now @chad-earthscope, but let me know if you have any comments

@megies megies merged commit 4278452 into master May 17, 2024
33 checks passed
@megies megies deleted the rename_iris branch May 17, 2024 06:13
@chad-earthscope
Copy link
Contributor

Thanks @megies, very appreciated change that I've had in the back of my mind, but have no time to deal with. "EarthScope" is probably best label for now ("SAGE" is our funders facility name, which will change next year).

I agree with all your changes with one exception: "IRISWS Federator" should be "EarthScope Federator". While there is irisws in the interfaces paths, which will remain indefinitely for compatibility, everything else around it will be EarthScope branded.

@megies megies mentioned this pull request May 21, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build_docs Docs will be automatically built and deployed in github actions on pushes to the PR docs issues that only affect the content of documentation pages, docstrings etc ready for review PRs that are ready to be reviewed to get marked ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Renaming IRIS -> Earthscope
4 participants