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

Migrate python packages #2896

Merged
merged 17 commits into from
Jan 18, 2024
Merged

Conversation

cssherman
Copy link
Contributor

@cssherman cssherman commented Dec 14, 2023

This PR removes old copies of the python packages that have been moved to their own repository: https://github.com/GEOS-DEV/geosPythonPackages . The setupPythonEnvironment.bash script will now fetch the latest version of these packages from the internet.

integratedTests PR: https://github.com/GEOS-DEV/integratedTests/pull/77

@cssherman cssherman requested a review from TotoGaz December 14, 2023 23:01
@cssherman cssherman self-assigned this Dec 14, 2023
@cssherman
Copy link
Contributor Author

@rrsettgast - for this change to work smoothly, we'll also want to move the python tool documentation to the new repo. I've done so here: GEOS-DEV/geosPythonPackages#1 . We should be able to treat this repo as a subproject in readthedocs (see https://docs.readthedocs.io/en/stable/subprojects.html). Any thoughts/concerns?

@untereiner untereiner linked an issue Dec 15, 2023 that may be closed by this pull request
@cssherman
Copy link
Contributor Author

Here are the new separate docs for the python tools: https://geosx-geospythonpackages.readthedocs-hosted.com/en/latest/
As a final step, I'll need to go through, remove old files, and update links to the new docs.

@untereiner
Copy link
Contributor

@cssherman Could this new repo have its own CI for the docs instead of fetching it in this repository ?

@cssherman
Copy link
Contributor Author

@cssherman Could this new repo have its own CI for the docs instead of fetching it in this repository ?

Yes, that's what I'm working towards. The RTD platform allows sub-projects, with different release schedules per repo

TMP_CLONE_DIR=$(mktemp -d)
PACKAGE_DIR=$TMP_CLONE_DIR/geosPythonPackages
git clone --depth 1 --branch main --single-branch https://github.com/GEOS-DEV/geosPythonPackages.git $PACKAGE_DIR
elif [ ! -d "${PACKAGE_DIR}/geosx_xml_tools_package" ]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is just a quick check to see if the directory is close to correct. There are later error messages that will be printed if other packages are broken/missing.

@cssherman cssherman force-pushed the feature/sherman/migratePythonPackages branch from b9249a1 to f6e9892 Compare December 20, 2023 00:26
@rrsettgast rrsettgast requested a review from wrtobin December 21, 2023 18:17
@cssherman cssherman added ci: run integrated tests Allows to run the integrated tests in GEOS CI flag: requires rebaseline Requires rebaseline branch in integratedTests labels Dec 21, 2023
@cssherman cssherman requested a review from CusiniM January 4, 2024 18:02
if $VERBOSE
INSTALL_MSG=$($PYTHON_TARGET -m $PIP_CMD install $p)
INSTALL_MSG=$($PYTHON_TARGET -m $PIP_CMD install $PACKAGE_DIR/$p)
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it possible to install directly from the url (like python -m pip install https://github.com/GEOS-DEV/geosPythonPackages.git/...)?
That would prevent us from removing by hand the temporary which is always a scary part.

)

else()
message(WARNING "Building the GEOSX python tools requires Python >= 3.6.")
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
message(WARNING "Building the GEOSX python tools requires Python >= 3.6.")
message(WARNING "Building the GEOSX python tools requires Python >= 3.6. No version was provided.")

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
message(WARNING "Building the GEOSX python tools requires Python >= 3.6.")
message(WARNING "Building the GEOS python tools requires Python >= 3.6. No version was provided.")

@cssherman cssherman force-pushed the feature/sherman/migratePythonPackages branch from f6e9892 to 1e71457 Compare January 11, 2024 21:53
@cssherman cssherman added the ci: run CUDA builds Allows to triggers (costly) CUDA jobs label Jan 12, 2024
@CusiniM
Copy link
Collaborator

CusiniM commented Jan 12, 2024

why does this require baselines ?

WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
)

add_custom_target( geosx_python_tools
Copy link
Collaborator

@CusiniM CusiniM Jan 17, 2024

Choose a reason for hiding this comment

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

shouldn't we call these geos_python_tools at some point?

Copy link

codecov bot commented Jan 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4ad8f0b) 51.42% compared to head (d8dc095) 51.42%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2896   +/-   ##
========================================
  Coverage    51.42%   51.42%           
========================================
  Files          966      966           
  Lines        86672    86672           
========================================
  Hits         44571    44571           
  Misses       42101    42101           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cssherman cssherman merged commit 796a458 into develop Jan 18, 2024
@cssherman cssherman deleted the feature/sherman/migratePythonPackages branch January 18, 2024 18:46
ouassimkh pushed a commit that referenced this pull request Feb 16, 2024
* Migrating python packages to a new repo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI flag: requires rebaseline Requires rebaseline branch in integratedTests type: cleanup / refactor Non-functional change (NFC)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Python package for pre/post-processing tools
5 participants