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

Various changes #549

Merged
merged 31 commits into from
Sep 5, 2024
Merged

Various changes #549

merged 31 commits into from
Sep 5, 2024

Conversation

bwohlberg
Copy link
Collaborator

Various changes, primarily related to documentation, including discussion of supported Python version.

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Aug 21, 2024
Copy link
Contributor

@Michael-T-McCann Michael-T-McCann left a comment

Choose a reason for hiding this comment

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

Added optional suggestions.


::

conda create -n scico python=3.9
conda create -n scico python=3.11
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest conda create -n temp "python>=3.10,<3.13" as a more future-proof option.

Copy link
Contributor

Choose a reason for hiding this comment

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

Or maybe conda create -n scico python=3.10 if that really is the version that is most thoroughly tested.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Switched to 3.12, which is the current stable version, and also the version tested in scico CI.

``jaxlib`` on Windows. However, Windows users can use SCICO via the
`Windows Subsystem for Linux
thoroughly tested, and is the minimum supported Python version for
the most recent versions of JAX.) It is supported on both Linux and
Copy link
Contributor

Choose a reason for hiding this comment

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

"It is supported..." -> "SCICO is supported"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.


::

./make_conda_env.sh -y -e py39
./make_conda_env.sh -y -e py310
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this env should be called scico to make it more consistent with docs/source/contributing.rst

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

@@ -43,14 +41,7 @@ def variable_assign_value(path: str, var: str) -> Any:
try:
# See http://stackoverflow.com/questions/2058802
Copy link
Contributor

Choose a reason for hiding this comment

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

Could link directly to the answer used, which I think is https://stackoverflow.com/a/30471662

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

@bwohlberg bwohlberg merged commit 220802c into main Sep 5, 2024
18 checks passed
@bwohlberg bwohlberg deleted the brendt/misc branch September 5, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants