-
Notifications
You must be signed in to change notification settings - Fork 43
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
Sdg23 update installation quick start page #440
Open
namiroues
wants to merge
5
commits into
MDAnalysis:master
Choose a base branch
from
namiroues:sdg23-update-installation-quick-start-page
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+25
−38
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0688019
FIX broken links
namiroues 884c18e
add mamba instructions and refine installation quick start
namiroues 20d7e8f
Merge branch 'master' into sdg23-update-docs
namiroues 48bad02
add mamba instructions and refine installation quick start
namiroues aef7dbc
address PR review comments
namiroues File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,65 +4,52 @@ title: Installation Quick Start | |
order: 2 | ||
--- | ||
|
||
MDAnalysis offers two methods to install the released version. For most | ||
users we recommend the [*Conda*](#conda) installation method. | ||
MDAnalysis can be installed using [mamba][], a faster drop-in replacement for [conda][], or [pip][]. | ||
|
||
## Conda ## | ||
## mamba/conda ## | ||
|
||
If you don't have [conda][] installed yet, follow the [installation | ||
instructions for conda][]. | ||
|
||
To install the lastest stable release with [conda][conda] do: | ||
|
||
{% highlight bash %} | ||
conda config --add channels conda-forge | ||
conda install mdanalysis | ||
{% endhighlight %} | ||
|
||
To upgrade to the latest stable release. | ||
If you don't have [mamba][] installed you can follow the [mamba installation instructions][]. | ||
To install MDAnalysis run: | ||
|
||
{% highlight bash %} | ||
conda update mdanalysis | ||
mamba install -c conda-forge mdanalysis | ||
{% endhighlight %} | ||
|
||
To [run the test cases][run_tests] and examples, also install the unit tests (about 53 MiB | ||
in size): | ||
To install [test cases][] cases (about 90 MB | ||
in size) run: | ||
|
||
{% highlight bash %} | ||
conda install MDAnalysisTests | ||
mamba install -c conda-forge MDAnalysisTests | ||
{% endhighlight %} | ||
|
||
The conda packages currently only support serial calculations. If you | ||
plan to use the parallel [OpenMP][OpenMP] algorithms you need to | ||
install MDAnalysis from the [Python Package | ||
Index](#python-package-index) and have a working OpenMP installation. | ||
MDAnalysis via [mamba][] supports only serial calculations. | ||
For OpenMP-based parallelism, use [pip][] and ensure you have | ||
Comment on lines
+25
to
+26
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. Is this still true? @hmacdope ? |
||
a working [OpenMP][] installation. | ||
|
||
## Python Package Index ## | ||
|
||
To install the latest stable release with | ||
[pip][pip] (which should be available in all Python installations) do: | ||
To install MDAnalysis with [pip][] run: | ||
|
||
{% highlight bash %} | ||
pip install --upgrade MDAnalysis | ||
{% endhighlight %} | ||
|
||
To [run the test cases][run_tests] and examples, also install the unit tests (about 53 MiB | ||
in size): | ||
To install [test cases][] run: | ||
|
||
{% highlight bash %} | ||
pip install --upgrade MDAnalysisTests | ||
{% endhighlight %} | ||
|
||
## More ## | ||
|
||
For more details on installation and alternative ways to install MDAnalysis see [Installing | ||
MDAnalysis in the {{ site.docs.userguide.name }}]({{ site.docs.userguide.url }}/stable/installation.html). | ||
For more details about the installation see the [Installation instuctions in the {{ site.docs.userguide.name }}]({{ site.docs.userguide.url }}/stable/installation.html). | ||
|
||
If you have questions with the installation, please ask on | ||
If you have questions regarding the installation, please ask on | ||
[{{site.mailinglists.discussion.name}}]({{site.mailinglists.discussion.url}}). | ||
|
||
[pip]: https://pip.pypa.io/en/latest/ | ||
[mamba]:https://anaconda.org/conda-forge/mamba | ||
[conda]: https://conda.io/ | ||
[installation instructions for conda]: https://conda.io/projects/conda/en/latest/user-guide/install/index.html | ||
[mamba installation instructions]: https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html | ||
[OpenMP]: https://www.openmp.org/ | ||
[run_tests]: {{ site.docs.userguide.url }}/stable/installation.html#testing | ||
[test cases]: {{ site.docs.userguide.url }}/stable/installation.html#testing |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
I think we should still have links to installing mamba/miniforge (see MDAnalysis/UserGuide#361 (comment) ) and conda. There are people who don't use it every day. It's important to give some minimal guidance. It's also a bit odd to recommend mamba but requiring people to somehow have conda already installed.