-
Notifications
You must be signed in to change notification settings - Fork 9
docs: document installation via Anaconda's commercial main-x channel #1069
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -17,6 +17,36 @@ the hierarchical data format (HDF5), which requires the [h5py](https://www.h5py. | |||||||
| schedulers, which requires the [Python simple queuing system adatper (pysqa)](https://pysqa.readthedocs.io) and the | ||||||||
| visualisation of dependencies, which requires a number of visualisation packages. | ||||||||
|
|
||||||||
| ## Commercial Distribution | ||||||||
| For commercial users [Anaconda](https://www.anaconda.com) provides the [main-x channel](https://www.anaconda.com/industries) | ||||||||
| as part of its commercial distribution and `executorlib` is available on this channel. This allows commercial users to | ||||||||
| install `executorlib` the same way as the [conda-forge](https://conda-forge.org) community distribution, just via a | ||||||||
| channel which includes commercial support from Anaconda. | ||||||||
|
|
||||||||
| To use the commercial distribution, first install [miniconda](https://www.anaconda.com/download) and then login to your | ||||||||
| [anaconda.com](https://www.anaconda.com) account from the command line using: | ||||||||
| ``` | ||||||||
| anaconda login | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: sed -n '1,80p' docs/installation.mdRepository: pyiron/executorlib Length of output: 5263 🌐 Web query:
💡 Result: Install The documented flow installs Miniconda and then runs Suggested fix+conda update --name base anaconda-auth
anaconda loginThis is a minor documentation gap with a simple workaround, not a major issue. 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||
| ``` | ||||||||
| This redirects to [auth.anaconda.com/ui/activate](https://auth.anaconda.com/ui/activate) to activate your | ||||||||
| [anaconda.com](https://www.anaconda.com) account on the current device. Afterwards, add the `main-x` channel to the | ||||||||
| conda configuration in addition to the default `main` channel: | ||||||||
| ``` | ||||||||
| conda config --append default_channels https://repo.anaconda.com/pkgs/main | ||||||||
| conda config --append default_channels https://repo.anaconda.cloud/repo/main-x | ||||||||
| ``` | ||||||||
| More details on setting up the `main-x` channel are available in the [official documentation](https://www.anaconda.com/docs/getting-started/main-x). | ||||||||
| Once the channels are configured `executorlib` can be installed with: | ||||||||
| ``` | ||||||||
| conda install executorlib | ||||||||
| ``` | ||||||||
| Or for a more extensive environment with a number of additional dependencies: | ||||||||
| ``` | ||||||||
| conda install executorlib pysqa jupyter h5py pygraphviz mpi4py networkx | ||||||||
| ``` | ||||||||
| A demonstration notebook which covers the installation and basic usage of `executorlib` via the commercial Anaconda | ||||||||
| distribution is available in the [executorlib-support repository](https://github.com/pyiron-dev/executorlib-support/blob/main/executorlib.ipynb). | ||||||||
|
|
||||||||
| ## MPI support | ||||||||
| The submission of MPI parallel Python functions requires the installation of the [mpi4py](https://mpi4py.readthedocs.io) | ||||||||
| package. This can be installed in combination with executorlib using either the [Python package manager](https://pypi.org/project/mpi4py/): | ||||||||
|
|
||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
Repository: pyiron/executorlib
Length of output: 23797
🏁 Script executed:
Repository: pyiron/executorlib
Length of output: 23769
🌐 Web query:
site:anaconda.com/docs/getting-started/main-x main-x standard authenticated setup paid plan Anaconda Platform Package Security Manager💡 Result:
Clarify the target Anaconda offering.
The main-x documentation states that
main-xis available to all registered users and describes separate access paths for Anaconda Platform and Package Security Manager. This section presents the generic authenticatedmain-xsetup as a “Commercial Distribution,” which conflates standard access with paid offerings. If this targets paid users, add the plan-specific setup. If it targets standardmain-x, change the heading and description.🤖 Prompt for AI Agents
Source: MCP tools