-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
401a83a
commit 66a9fb0
Showing
1 changed file
with
18 additions
and
2 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,24 @@ | ||
.. _docs-chem_introduction: | ||
|
||
.. figure:: ../_static/images/xmipp.png | ||
.. figure:: ../_static/images/xmipp_noBackground.png | ||
:alt: xmipp logo | ||
:width: 400 | ||
|
||
Welcome to Xmipp documentation! | ||
======================================== | ||
======================================== | ||
drawing | ||
|
||
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. | ||
|
||
The Xmipp project is divided into four repositories:`xmipp <https://github.com/I2PC/xmipp>`, | ||
`xmippCore <>`, `scipion-em-xmipp <https://github.com/I2PC/scipion-em-xmipp>` and `xmippVix <https://github.com/I2PC/xmippViz>`, | ||
are automatically downloaded during the installation process. | ||
|
||
Getting started | ||
---------------- | ||
The recommended way for users (not developers) to install and use Xmipp is via the Scipion | ||
framework, where you can use Xmipp with other Cryo-EM-related software. Xmipp will be installed during Scipion installation | ||
(pay attemption on the -noXmipp flag). The Scipion installer should take care of all dependencies for you, however, you can make | ||
its life easier if you have your compiler, CUDA and HDF5 library ready and available in the standard paths. Read the installation | ||
page for more details about these softwares requirements. Follow the official installation guide of Scipion for more details. |