-
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
0 parents
commit e70efc8
Showing
55 changed files
with
5,624 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 81deec6a464779255dfab988332950f5 | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
|
||
# Xmipp | ||
<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> | ||
This is the full content: [https://i2pc.github.io/docs/](https://i2pc.github.io/docs/) | ||
|
||
|
||
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. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
.. _contact-us: | ||
|
||
========== | ||
Contact us | ||
========== | ||
From the xmipp-team we would be happy to hear your doubts and suggestions, do not hesitate to contact us at any | ||
time. To do so, you can either open an issue in the Github repository related to your question or | ||
contact us by mail. | ||
|
||
======================= | ||
If the question is related to the Scipion framework, try the `contact us <https://scipion.i2pc.es/contact>`_ page. | ||
If it is related to someThe easiest way to reach us is by writing to our mail: `[email protected] <mailto:[email protected] >` or `[email protected] <mailto:[email protected]>` | ||
|
||
Discord channel | ||
======================= | ||
The easiest way to reach us is by writing to our Xmipp channel on the Scipion framework. Request access at `scipion team <mailto:[email protected]>` | ||
|
||
Support for developers | ||
================ | ||
That way you will get almost immediate answers to your "dev-doubts" is by writing to our Xmipp channel on the Scipion framework. You can also `create an issue <https://github.com/I2PC/xmipp/issues>` to report a bug or suggest a new feature. Remember we have four repositories for Xmipp: `xmipp <https://github.com/I2PC/xmipp>`, `xmippCore <>`, `scipion-em-xmipp <https://github.com/I2PC/scipion-em-xmipp>` and `xmippVix <https://github.com/I2PC/xmippViz>`) |
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 |
---|---|---|
@@ -0,0 +1,24 @@ | ||
.. _docs-chem_introduction: | ||
|
||
.. 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. |
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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
.. _license: | ||
|
||
License | ||
======== | ||
All Xmipp code and plugins, are licensed under the `GPL3 License <http://www.gnu.org/licenses/gpl-3.0.html>`_. | ||
|
||
Now, Xmipp interacts, and in some cases installs 3rd party software with its own license that must be observed. | ||
|
||
So, it is under the user's responsibility to check the license of each software Xmipp is installing. | ||
|
||
In most cases, if not all, software is freely available for academic use and industry but there are few exceptions where industry | ||
users, or in some extreme cases even academic ones, are not granted free usage. You must check in each case. |
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 |
---|---|---|
@@ -0,0 +1,123 @@ | ||
/* Compatability shim for jQuery and underscores.js. | ||
* | ||
* Copyright Sphinx contributors | ||
* Released under the two clause BSD licence | ||
*/ | ||
|
||
/** | ||
* small helper function to urldecode strings | ||
* | ||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL | ||
*/ | ||
jQuery.urldecode = function(x) { | ||
if (!x) { | ||
return x | ||
} | ||
return decodeURIComponent(x.replace(/\+/g, ' ')); | ||
}; | ||
|
||
/** | ||
* small helper function to urlencode strings | ||
*/ | ||
jQuery.urlencode = encodeURIComponent; | ||
|
||
/** | ||
* This function returns the parsed url parameters of the | ||
* current request. Multiple values per key are supported, | ||
* it will always return arrays of strings for the value parts. | ||
*/ | ||
jQuery.getQueryParameters = function(s) { | ||
if (typeof s === 'undefined') | ||
s = document.location.search; | ||
var parts = s.substr(s.indexOf('?') + 1).split('&'); | ||
var result = {}; | ||
for (var i = 0; i < parts.length; i++) { | ||
var tmp = parts[i].split('=', 2); | ||
var key = jQuery.urldecode(tmp[0]); | ||
var value = jQuery.urldecode(tmp[1]); | ||
if (key in result) | ||
result[key].push(value); | ||
else | ||
result[key] = [value]; | ||
} | ||
return result; | ||
}; | ||
|
||
/** | ||
* highlight a given string on a jquery object by wrapping it in | ||
* span elements with the given class name. | ||
*/ | ||
jQuery.fn.highlightText = function(text, className) { | ||
function highlight(node, addItems) { | ||
if (node.nodeType === 3) { | ||
var val = node.nodeValue; | ||
var pos = val.toLowerCase().indexOf(text); | ||
if (pos >= 0 && | ||
!jQuery(node.parentNode).hasClass(className) && | ||
!jQuery(node.parentNode).hasClass("nohighlight")) { | ||
var span; | ||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); | ||
if (isInSVG) { | ||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); | ||
} else { | ||
span = document.createElement("span"); | ||
span.className = className; | ||
} | ||
span.appendChild(document.createTextNode(val.substr(pos, text.length))); | ||
node.parentNode.insertBefore(span, node.parentNode.insertBefore( | ||
document.createTextNode(val.substr(pos + text.length)), | ||
node.nextSibling)); | ||
node.nodeValue = val.substr(0, pos); | ||
if (isInSVG) { | ||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); | ||
var bbox = node.parentElement.getBBox(); | ||
rect.x.baseVal.value = bbox.x; | ||
rect.y.baseVal.value = bbox.y; | ||
rect.width.baseVal.value = bbox.width; | ||
rect.height.baseVal.value = bbox.height; | ||
rect.setAttribute('class', className); | ||
addItems.push({ | ||
"parent": node.parentNode, | ||
"target": rect}); | ||
} | ||
} | ||
} | ||
else if (!jQuery(node).is("button, select, textarea")) { | ||
jQuery.each(node.childNodes, function() { | ||
highlight(this, addItems); | ||
}); | ||
} | ||
} | ||
var addItems = []; | ||
var result = this.each(function() { | ||
highlight(this, addItems); | ||
}); | ||
for (var i = 0; i < addItems.length; ++i) { | ||
jQuery(addItems[i].parent).before(addItems[i].target); | ||
} | ||
return result; | ||
}; | ||
|
||
/* | ||
* backward compatibility for jQuery.browser | ||
* This will be supported until firefox bug is fixed. | ||
*/ | ||
if (!jQuery.browser) { | ||
jQuery.uaMatch = function(ua) { | ||
ua = ua.toLowerCase(); | ||
|
||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || | ||
/(webkit)[ \/]([\w.]+)/.exec(ua) || | ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || | ||
/(msie) ([\w.]+)/.exec(ua) || | ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || | ||
[]; | ||
|
||
return { | ||
browser: match[ 1 ] || "", | ||
version: match[ 2 ] || "0" | ||
}; | ||
}; | ||
jQuery.browser = {}; | ||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; | ||
} |
Oops, something went wrong.