Skip to content

Add conda, mamba, and pixi installation methods to documentation #11

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.

Sign up for GitHub

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

Open
eunos-1128 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add conda, mamba, and pixi installation methods to documentation #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,37 @@ proteins, in both schematic and detailed representations.

The documentation is at [http://pekrau.github.io/MolScript/](http://pekrau.github.io/MolScript/).

Installation
------------

### Using Conda

MolScript is available on conda-forge and can be easily installed using:

```bash
conda install -c conda-forge molscript
```

### Using Mamba

[Mamba](https://mamba.readthedocs.io/) is a fast, drop-in replacement for conda:

```bash
mamba install -c conda-forge molscript
```

### Using Pixi

[Pixi](https://pixi.sh/) is a modern, fast package manager that uses conda packages. To install MolScript globally:

```bash
pixi global install molscript
```

### From Source

For building from source, please see the [installation documentation](http://pekrau.github.io/MolScript/installation.html).

Background
----------

Expand Down
90 changes: 79 additions & 11 deletions docs/installation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,84 @@

<h1 align=center>Installation</h1>

<ul>
<li><a href="#package-managers">Installation via Package Managers</a>
<ul>
<li><a href="#conda">Using Conda</a>
<li><a href="#mamba">Using Mamba</a>
<li><a href="#pixi">Using Pixi</a>
</ul>
<li><a href="#source">Installation from Source</a>
<ul>
<li><a href="#distribution">The distribution</a>
<li><a href="#save">Save previous MolScript versions</a>
<li><a href="#unpacking">Unpacking the distribution file</a>
<li><a href="#directory">Directory structure of the distribution</a>
<li><a href="#external">External software libraries</a>
<li><a href="#Makefiles">The Makefiles</a>
<li><a href="#compiling">Compiling the software</a>
<li><a href="#examples">Rendering the example files</a>
</ul>
</ul>

<hr>
<h2><a name="package-managers">Installation via Package Managers</a></h2>

For most users, installing MolScript via a package manager is the easiest method.

<h3><a name="conda">Using Conda</a></h3>

MolScript is available on the conda-forge channel. You can install it using:

<code><blockquote>
conda install -c conda-forge molscript
</blockquote></code>

Or, if you have conda-forge configured as a priority channel:

<code><blockquote>
conda install molscript
</blockquote></code>

To configure conda-forge as a priority channel:

<code><blockquote>
conda config --add channels conda-forge<br>
conda config --set channel_priority strict
</blockquote></code>

<h3><a name="mamba">Using Mamba</a></h3>

<a href="https://mamba.readthedocs.io/">Mamba</a> is a fast, drop-in replacement for conda. You can install MolScript using:

<code><blockquote>
mamba install -c conda-forge molscript
</blockquote></code>

Or, if you have conda-forge configured as a priority channel:

<code><blockquote>
mamba install molscript
</blockquote></code>

<h3><a name="pixi">Using Pixi</a></h3>

<a href="https://pixi.sh/">Pixi</a> is a modern, fast package manager that uses conda packages. To install MolScript globally with Pixi:

<code><blockquote>
pixi global install molscript
</blockquote></code>

Or, specifying the conda-forge channel explicitly:

<code><blockquote>
pixi global install -c conda-forge molscript
</blockquote></code>

<p>
<hr>
<h2><a name="source">Installation from Source</a></h2>

The installation procedure for v2.1 has been simplified compared to
v2.0. The directory structure of the distribution has changed.
<p>
Expand All @@ -33,17 +111,7 @@ <h1 align=center>Installation</h1>
<a href="mailto:per.kraulis@gmail.com">per.kraulis@gmail.com</a>. The
description will be incorporated into this documentation.

<ul>
<li><a href="#distribution">The distribution</a>
<li><a href="#save">Save previous MolScript versions</a>
<li><a href="#unpacking">Unpacking the distribution file</a>
<li><a href="#directory">Directory structure of the distribution</a>
<li><a href="#external">External software libraries</a>
<li><a href="#Makefiles">The Makefiles</a>
<li><a href="#compiling">Compiling the software</a>
<li><a href="#examples">Rendering the example files</a>
</ul>

<p>
<hr>
<h2><a name="distribution">The distribution</a></h2>

Expand Down