xcube-dev / xcube-dev/xcengine
Decide how to deal with environment issues during parameter extraction
@pont-us is already working on this.
Since Apr 4, 2025.
- Dominant language
- Python
- Stars
- 4
- Forks
- 0
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 8
Description
The parameter extraction procedure requires that xcetool runs the notebook up to the parameters cell. This could potentially require elements of the notebook's expected environment (Python packages and environment variables) to be present in the environment where xcetool is running. In the most extreme case, the entire notebook environment might be required. In many cases that's not a problem -- e.g. in a typical Jupyter Lab environment xcetool may run in a Jupyter Lab terminal tab in exactly the same environment as the notebook. But there are other scenarios. Initial thoughts:
- This requirement, and potential solutions to related problems, should be clearly documented. Generally some simple notebook rearrangement (parameter cell as early as possible) should be enough.
- It might be worth providing something like a
--continueoption which would ignore errors during parameter extraction and make a best effort, and/or an option to ignore the pre-parameter-cell code entirely. In many (most?) cases this should be sufficient.
Note that this topic concerns the environment in which xcetool runs, not the environment in which the exported script will run.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.