Skip to content

Update install setup#15

Merged
minghangli-uni merged 13 commits into
mainfrom
update-install-setup
Feb 13, 2026
Merged

Update install setup#15
minghangli-uni merged 13 commits into
mainfrom
update-install-setup

Conversation

@minghangli-uni
Copy link
Copy Markdown
Collaborator

@minghangli-uni minghangli-uni commented Feb 9, 2026

This is a draft for now.


Include optional dependencies:

  • access-experiment-generator@main
  • access-experiment-runner@main
  • access-profiling@47-om3-profiling_temporary
  • access-config-utils@32-accessom3-layout

The last two will be updated to main branches too once merged.

EDIT:

The associated optional dependencies are only required for interactive use (e.g. ARE Jupyter Notebook workflows).


EDIT:
The tool setup is a bit tricky because esmf-trace does not depend on packages such as access-experiment-generator, access-experiment-runner, access-config-utils, or access-profiling in order to run. These packages are independent tools.

However in practice, users often install these repos into the same python virtual environment to construct end-to-end workflows for profiling and scaling ACCESS models (e.g. experiment generation -> execution -> trace analysis). Hence to keep packaging semantics correct while still supporting these workflows, I propose the following structure:

  • pyproject.toml describes only the dependencies required to run esmf-trace itself (plus optional dev/test/interactive tooling if needed).
  • Companion ACCESS repos, such as the above four mentioned and potentially others are not listed as package dependencies, but are instead installed via a workspace requirements file.
  • The workspace requirements file defines a curated set of repos that can be co-installed into the same virtual environment to support profiling and scaling workflows, without implying a hard dependency relationship.

The goal is to keep esmf-trace packaging clean so it can be published upstream to Spack, while still supporting common end-to-end ACCESS workflows.

@minghangli-uni minghangli-uni self-assigned this Feb 9, 2026
@minghangli-uni minghangli-uni marked this pull request as ready for review February 12, 2026 22:30
Copy link
Copy Markdown
Collaborator

@manodeep manodeep left a comment

Choose a reason for hiding this comment

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

Had a few comments but looks fine overall - though, admittedly, I am not up-to-date with what's been going on with python packaging in the last ~5 years (post setuptools)

Comment thread pyproject.toml
Comment thread setup_gadi.sh
Comment thread setup_gadi.sh Outdated
Copy link
Copy Markdown
Collaborator

@manodeep manodeep left a comment

Choose a reason for hiding this comment

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

Not sure my approval will count though since I do not have write access

@minghangli-uni minghangli-uni merged commit 28d7bf1 into main Feb 13, 2026
6 checks passed
@minghangli-uni minghangli-uni deleted the update-install-setup branch February 13, 2026 04:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants