Skip to content

Commit

Permalink
index main
Browse files Browse the repository at this point in the history
  • Loading branch information
albertmena authored Oct 5, 2023
1 parent 401a83a commit 66a9fb0
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions docs/index.rst
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.

0 comments on commit 66a9fb0

Please sign in to comment.