Skip to content

Commit 07bfee4

Browse files
authored
Merge branch 'main' into xmipp_cu13
2 parents 6587251 + efd34bb commit 07bfee4

1 file changed

Lines changed: 3 additions & 48 deletions

File tree

README.md

Lines changed: 3 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,7 @@
11
[![Build Status](https://github.com/I2PC/xmipp/actions/workflows/build.yml/badge.svg)](https://github.com/I2PC/xmipp/actions/workflows/build.yml)
22

33
# Xmipp
4-
<a href="https://github.com/I2PC/xmipp"><img src="https://github.com/I2PC/scipion-em-xmipp/blob/devel/xmipp3/xmipp_logo.png" alt="drawing" width="330" align="left"></a>
4+
<a href="https://github.com/I2PC/xmipp"><img src="https://github.com/I2PC/scipion-em-xmipp/blob/main/xmipp3/xmipp_logo.png" alt="drawing" width="330" align="left"></a>
55

6-
7-
8-
Xmipp is a suite of image processing programs, primarily aimed at single-particle 3D electron microscopy, designed and managed by the [Biocomputing Unit](http://biocomputingunit.es/) located in Madrid, Spain.
9-
10-
The Xmipp project is divided into four repositories.
11-
This is the main repository, which contains the majority of the source code for the programs, additional scripts, and tests. Three remaining repositories, [XmippCore](https://github.com/I2PC/xmippCore/), [XmippViz](https://github.com/I2PC/xmippViz/), and [Scipion-em-xmipp](https://github.com/I2PC/scipion-em-xmipp), are automatically downloaded during the installation process.
12-
13-
14-
## Getting started
15-
To have a complete overview about Xmipp please visit the [documentation web](https://i2pc.github.io/docs/). The recommended way for users (not developers) to install and use Xmipp is via the [Scipion](http://scipion.i2pc.es/) framework, where you can use Xmipp with other Cryo-EM-related software.
16-
17-
18-
19-
### Installation Telemetry
20-
21-
Xmipp collects **basic information about your installation environment** (such as library versions, system architecture, and operating system) to improve compatibility, performance, and stability.
22-
23-
If you prefer **not to send this data**, you can disable collection by setting: `export XMIPP3_SEND_INSTALLATION_STATISTICS=OFF` as environment variable
24-
For more information, please visit [Data collection](https://i2pc.github.io/docs/Others/Enhancing/index.html#data-collection)
25-
26-
27-
### Developer installation with Scipion
28-
For developers, it becomes handy to install Xmipp in an external directory for easy integration with IDEs. By default Xmipp installer takes care of linking to Scipion.
29-
30-
The first step is to download Xmipp sources:
31-
32-
`git clone https://github.com/I2PC/xmipp.git xmipp-bundle & cd xmipp-bundle`
33-
34-
If you want to checkout an scpecific branch use the following command. For repositories where the branch does not exist, devel is utilized.
35-
36-
`./xmipp getSources -b branch`
37-
38-
Compile Xmipp
39-
40-
`scipion3 run ./xmipp`
41-
42-
Refer to `./xmipp --help` for additional info on the compilation process and possible customizations.
43-
44-
Install the Scipion plugin.
45-
46-
`scipion3 installp -p src/scipion-em-xmipp --devel`
47-
48-
## That's all
49-
50-
If you miss some feature or find a bug, please [create an issue](https://github.com/I2PC/xmipp/issues/new) and we will have a look at it, you can also contact us by xmipp@cnb.csic.es or Discord (Scipion chanel). For more details, troubleshootings and information visit the [documentation web.]([https://github.com/I2PC/xmipp/wiki](https://i2pc.github.io/docs/index.html))
51-
52-
If you like this project, Watch or Star it! We are also looking for new collaborators, so contact us if you’re interested
6+
# Full documentation
7+
To have a complete overview about Xmipp please visit the [documentation web](https://i2pc.github.io/docs/).

0 commit comments

Comments
 (0)