GEOS-DEV / GEOS-DEV/GEOS

Renaming `geosx` into `geos`

Open
#2,331 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: cleanup / refactor
Dominant language
C++
Stars
287
Forks
109
Avg merge
4d 41m
Merged PRs (30d)
5

Description

Hello guys, since it was decided to rename geosx into geos, it’s now time to take the appropriate actions and reflect the change in our code and organisations!

I’ve listed below what I could come accros. Please feel free to update the list so we’re sure we’re forgetting nothing.
Of course, when I write "Change ...", it means that we have to deal with the aftermath of the change as well (modifications of the scripts, tell our partners, etc).

I did not think about the best order to do all the actions yet. We need to sort this out and organize ourselves.

Regarding github

  • Change the github organisation from GEOSX to GEOS GEOS-DEV
  • Change the github repository from GEOSX to GEOS

While github provides forwarding from old name to new name, our jenkins/gitlab/travis will need to be updated accordingly.

Regarding other organisations

  • Change the readthedocs organisation and project (be careful, the url is hard coded in the C++ code).
  • Change the GCP bucket names that contain geosx.

  • Change the travis organisation and repositories.
  • Change the geosx.org website.
  • Update the deployment folders that often contain geosx.
  • Update the dockerhub organisation.

Regarding source code

  • Change the occurrences of geosx in the C++ namespace, GEOSX_ log/error macros, include guards...
    Done in https://github.com/GEOS-DEV/GEOS/pull/2392
  • Change the last occurrences of geosx in the C++ in the variable names, class names, files... Be careful of the uncrustify issues.
  • Do the same for other code (not C++), like our cmake code or our travis anchors.
  • Rewrite the "How does GEOSX relate to GEOS?" question!
    Done in https://github.com/GEOS-DEV/GEOS/pull/2575
  • Change the cmake variables to GEOS_, update doc accordingly.
  • Rename geosxats.
  • Rename pygeosx.

Regarding the geosx executable

Anything else?

This name change will cost us some time 🤣

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the unchecked checklist items as the scope, starting with the remaining C++ names and files, CMake variables, deployment folders, GCP buckets, ATS references, and Docker Hub organisation. Review the linked pull requests and existing rename work first; done means the remaining geosx occurrences and listed external integrations are updated without breaking scripts, documentation, or executable compatibility.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp, docker, gcp, github, gitlab
Domain
build-system, ci-cd, devops, documentation, release
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.