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

Recommend Mambaforge and mamba in the installation and contributing guides #2385

Merged
merged 3 commits into from
Mar 3, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Feb 27, 2023

Description of proposed changes

Preview:

Fixes #2368

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@@ -128,30 +128,23 @@ want):

.. tab-set::
Copy link
Member Author

Choose a reason for hiding this comment

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

At line 120, we have:

First, we must configure conda to get packages from the conda-forge channel

conda config --prepend channels conda-forge

This line is not necessary if users use Mambaforge + mamba, but are required if users use conda or install mamba in other ways.

I'm unsure if we should remove these lines and always add the --channel conda-forge option to conda/mamba commands.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe mention that this step is not needed if Mambaforge is used? Or we could just leave it, since running this command under Mambaforge doesn't hurt actually.

Copy link
Member Author

Choose a reason for hiding this comment

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

Or we could just leave it, since running this command under Mambaforge doesn't hurt actually.

Sounds good to me.

@seisman seisman added the documentation Improvements or additions to documentation label Feb 27, 2023
@seisman seisman added this to the 0.9.0 milestone Feb 28, 2023
@seisman seisman added the needs review This PR has higher priority and needs review. label Feb 28, 2023
@@ -128,30 +128,23 @@ want):

.. tab-set::
Copy link
Member

Choose a reason for hiding this comment

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

Maybe mention that this step is not needed if Mambaforge is used? Or we could just leave it, since running this command under Mambaforge doesn't hurt actually.

@weiji14 weiji14 added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Mar 2, 2023
@seisman seisman merged commit d546ae5 into main Mar 3, 2023
@seisman seisman deleted the mambaforge branch March 3, 2023 01:21
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 3, 2023
weiji14 added a commit that referenced this pull request Mar 11, 2023
Since `mamba` is recommended over `conda` as per #2385.
weiji14 added a commit that referenced this pull request Mar 11, 2023
Update a few more `conda` references to `mamba` in the main README and other locations that were missed out in #2385.
@weiji14 weiji14 mentioned this pull request Mar 11, 2023
7 tasks
michaelgrund pushed a commit that referenced this pull request Mar 12, 2023
Update a few more `conda` references to `mamba` in the main README and other locations that were missed out in #2385.
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.

Recommend mambaforge + mamba in the installation instructions and contributing guides
3 participants