Skip to content

Commit aaad7e5

Browse files
authored
.
1 parent 0bc59cb commit aaad7e5

File tree

1 file changed

+34
-46
lines changed
  • docs/Installation/Standlone-installation

1 file changed

+34
-46
lines changed
Lines changed: 34 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,50 @@
1-
Standalone installation
2-
-----------------------
1+
Installation Guide for Xmipp
32

4-
Standalone installation of Xmipp is recommended for researchers and
5-
developers. This installation allows you to use Xmipp without Scipion,
6-
however, in the next section it is explained how to link it with
7-
Scipion. Xmipp script automatically downloads several dependencies and
8-
then creates a configuration file that contains paths and flags used
9-
during the compilation. Please refer to the `Xmipp
10-
configuration <https://github.com/I2PC/xmipp/wiki/Xmipp-configuration>`__
11-
guide for more info.
3+
This guide explains the standalone installation of Xmipp and the process to link it with Scipion. The standalone version allows you to use Xmipp independently of Scipion. For details on linking, see the section *Linking Xmipp to Scipion*.
124

13-
Start by cloning the repository and then navigate to the right
14-
directory.
5+
Standalone Installation
156

16-
``git clone https://github.com/I2PC/xmipp.git xmipp-bundle && cd xmipp-bundle``
7+
1. Clone the repository and navigate to the folder:
178

18-
Refer to ``./xmipp --help`` for additional info on the compilation
19-
process and possible customizations.
9+
.. code-block:: bash
2010
21-
Next is to compile xmipp. There are two possibilities and in both you
22-
will can run Xmipp in Scipion (see `linking
23-
step <https://github.com/I2PC/xmipp/edit/agm_refactoring_readme/README.md#linking-xmipp-standalone-to-scipion>`__)
11+
git clone https://github.com/I2PC/xmipp.git xmipp-bundle && cd xmipp-bundle
2412
25-
- Compile Xmipp by invoking the compilation script, which will take you through the rest of the process:
13+
2. Compile Xmipp. You have two options:
2614

27-
``./xmipp``
15+
**Option 1:** Compile using the Xmipp environment. This method installs Xmipp with the required dependencies and versions defined by your environment or defaults.
2816

29-
that way you will install Xmipp with the dependencies and thier versions that the enviroment youdecide, or the default one.
17+
.. code-block:: bash
3018
31-
- Compile Xmipp via Scipion enviroment
19+
./xmipp
3220
33-
``scipion3 run ./xmipp``
21+
**Option 2:** Compile using the Scipion environment. This method installs Xmipp with dependencies managed by Scipion.
3422

35-
that way you will install Xmipp with the
36-
dependencies and their versions that Scipion decided.
23+
.. code-block:: bash
3724
38-
It is important to highlight that this step only compiles Xmipp, but it
39-
does not link to Scipion. The linking to Scipion is explained in the
40-
next section.
25+
scipion3 run ./xmipp
4126
42-
Linking Xmipp standalone to Scipion
43-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
27+
Both methods only compile Xmipp. Linking it to Scipion is explained in the next section.
4428

45-
Once the Standalone version has been installed, the user can link such
46-
installation to Scipion to have the posibility of use Xmipp inside
47-
Scipion. Linking with Scipion requires to the repository of
48-
``scipion-em-xmipp`` which can be found in the folder
49-
``src/scipion-em-xmipp``. This repository contains the files that
50-
Scipion needs to execute Xmipp programs. However, it remains to link the
51-
Xmipp binaries with Scipion. To do that we need Scipion installed (`see
52-
Scipion installation web
53-
page <https://scipion-em.github.io/docs/docs/scipion-modes/how-to-install.html#>`__)
54-
and just launch the next command to link the binaries
29+
3. For additional details about the compilation process, run:
5530

56-
``scipion3 installp -p ~/scipion-em-xmipp --devel``
31+
.. code-block:: bash
32+
33+
./xmipp --help
34+
35+
Linking Xmipp to Scipion
36+
37+
To use Xmipp within Scipion, link the standalone installation by following these steps:
38+
39+
1. Ensure Scipion is installed (refer to the *Scipion installation guide*).
40+
2. Use the `scipion-em-xmipp` repository, located in `src/scipion-em-xmipp`.
41+
3. Run the following command to link the binaries:
42+
43+
.. code-block:: bash
44+
45+
scipion3 installp -p ~/scipion-em-xmipp --devel
46+
47+
Replace `~/scipion-em-xmipp` with the path to your `scipion-em-xmipp` folder.
48+
49+
If Scipion does not detect Xmipp after linking, refer to *Linking Xmipp to Scipion Troubleshooting*.
5750

58-
where ``scipion-em-xmipp`` is the folder of the repository, it means
59-
``src/scipion-em-xmipp``. This command should work in most of the cases.
60-
However, if you do this and Scipion does not find Xmipp, please visit
61-
`Linking Xmipp to Scipion
62-
Troubleshooting <https://github.com/I2PC/xmipp/wiki/Linking-Xmipp-to-Scipion-Troubleshooting>`__

0 commit comments

Comments
 (0)